NI DIGITAL PATTERN DRIVER Pattern Configuration Functions

Pattern Configuration Functions

• niDigital_LoadPattern
• niDigital_UnloadAllPatterns
• niDigital_ConfigureStartLabel
• niDigital_ConfigurePatternBurstSites
• niDigital_GetPatternPinIndexes
• niDigital_GetPatternPinList
• niDigital_GetPatternName

niDigital_LoadPattern

Loads the specified pattern file.

C Function Prototype: ViStatus niDigital_LoadPattern (ViSession vi, ViConstString filePath)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
filePath	Absolute file path of the binary .digipat pattern file to load. Specify the pattern to burst using the niDigital_ConfigureStartLabel function or the startLabel parameter of the niDigital_BurstPattern function.

Return value: Reports the status of the operation.

niDigital_UnloadAllPatterns

Unloads all patterns, source waveforms, and capture waveforms from a digital pattern instrument.

C Function Prototype: ViStatus niDigital_UnloadAllPatterns (ViSession vi, ViBoolean unloadKeepAlivePattern)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
unloadKeepAlivePattern	A Boolean that specifies whether to keep or unload the keep alive pattern.

Return value: Reports the status of the operation.

niDigital_ConfigureStartLabel

Configures the pattern name or exported label in the loaded patterns from which to start bursting the pattern. If you want to start bursting the pattern from the first vector, specify the pattern name.

C Function Prototype: ViStatus niDigital_ConfigureStartLabel (ViSession vi, ViConstString label)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
label	Pattern name or exported pattern label from which to start bursting the pattern.

Return value: Reports the status of the operation.

niDigital_ConfigurePatternBurstSites

Configures which sites burst the pattern on the next call to the niDigital_Initiate function. The pattern burst sites can also be modified through the siteList parameter in the niDigital_BurstPattern function. If a site has been disabled through the niDigital_DisableSites function, the site does not burst a pattern even if included in the pattern burst sites.

C Function Prototype: ViStatus niDigital_ConfigurePatternBurstSites (ViSession vi, ViConstString siteList)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
siteList	A comma-delimited list of strings in the form of siteN, where N is the site number. If you specify an empty string, the function returns pass or fail results for all sites. If the string is empty, all sites are configured for pattern bursting.

Return value: Reports the status of the operation.

niDigital_GetPatternPinIndexes

Returns the indexes of the pins included in the pattern you specify.

C Function Prototype: ViStatus niDigital_GetPatternPinIndexes (ViSession vi, ViConstString startLabel, ViInt32 pinIndexesBufferSize, ViInt32[] pinIndexes, ViInt32* actualNumPins)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
startLabel	The specified pattern name or exported pattern label from which to get the pin names referenced by the pattern.
pinIndexesBufferSize	The number of elements in the ViInt32 array you specify for pinIndexes. To determine the size of the buffer to allocate for the pinIndexes array, pass a value of 0 to the pinIndexesBufferSize parameter and a value of VI_NULL to the pinIndexes parameter. In this case, the value returned by the actualNumPins parameter is the size of the array necessary to hold the pin indexes.
Output
pinIndexes	The returned pin indexes referenced by the pattern with the start label. Call niDigital_GetPinName to get the pin name associated with each pin index.
actualNumPins	Number of pin indexes written to the pinIndexes array.

Return value: Reports the status of the operation.

niDigital_GetPatternPinList

Returns the pattern pin list.

You must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the buffer size. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size, the function copies (buffer size - 1) bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7. If you want to call this function just to get the required buffer size, you can pass 0 for the buffer size and VI_NULL for the value.

C Function Prototype: ViStatus niDigital_GetPatternPinList (ViSession vi, ViConstString startLabel, ViInt32 pinListBufferSize, ViChar[] pinList)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
startLabel	Pattern name or exported pattern label from which to get the pin names that the pattern references.
pinListBufferSize	The number of elements in the ViChar array you specify for pinList.
Output
pinList	List of pins referenced by the pattern with the startLabel.

Return value: Reports the status of the operation.

niDigital_GetPatternName

Gets the name of a pattern from the pattern index.

You must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the bufferSize. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the bufferSize, the function copies (bufferSize - 1) bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the bufferSize you must pass to get the entire value. For example, if the value is "123456" and the bufferSize is 4, the function places "123" into the buffer and returns 7. If you want to call this function just to get the required buffer size, you can pass 0 for the bufferSize and VI_NULL for the value.

C Function Prototype: ViStatus niDigital_GetPatternName (ViSession vi, ViInt32 patternIndex, ViInt32 nameBufferSize, ViChar[] name)

Parameter	Description
vi	The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
patternIndex	The specified pattern index.
nameBufferSize	The number of elements in the ViChar array you specify for name.
Output
name	Returns the pin name at the specified pinIndex.

Return value: Reports the status of the operation.