niDigital_GetPatternPinList
- Updated2023-11-24
- 1 minute(s) read
niDigital_GetPatternPinList
Pattern Configuration Group
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. |
pinList | List of pins referenced by the pattern with the startLabel. |
Return value: Reports the status of the operation.