NI DIGITAL PATTERN DRIVER Sort Results Functions - ni/grpc-device GitHub Wiki
Returns the pin names, site numbers, and channel names that correspond to per-pin data read from the digital pattern instrument.
The function returns pin information in the same order as values read using the niDigital_ReadStatic function, niDigital_PPMU_Measure function, and niDigital_GetFailCount function. Use this function to match values the previously listed functions return with pins, sites, and instrument channels.
C Function Prototype: ViStatus niDigital_GetPinResultsPinInformation (ViSession vi, ViConstString channelList, ViInt32 bufferSize, ViInt32[] pinIndexes, ViInt32[] siteNumbers, ViInt32[] channelIndexes, ViInt32* actualNumValues)
| Parameter | Description |
|---|---|
| vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
| channelList |
List of channel names or list of pins. Do not pass a mix of channel names and pin names. An empty string denotes all digital pattern instrument channels. Pin names and pin groups apply to all enabled sites, unless the pin name explicitly specifies the site. You can specify a pin in a specific site using the form siteN/pinName, where N is the site number. This function ignores pins that are not mapped to the digital pattern instrument. Specify channel names using the form PXI1Slot3/0,2-3 or PXI1Slot3/0,PXI1Slot3/2-3, where PXI1Slot3 is the instrument resource name and 0, 2, 3 are channel names. To specify channels from multiple instruments, use the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3. The instruments must be in the same chassis. |
| bufferSize | The number of elements in the arrays you specify for pinIndexes, siteNumbers, and channelIndexes, if they are not NULL. To determine the size of the buffer to allocate for the arrays, pass a value of 0 to the bufferSize parameter and a value of VI_NULL to the array parameters. In this case, the value returned by the actualNumValues parameter is the size of the arrays necessary to hold the output values. |
| Output | |
| pinIndexes |
The returned index of the pins corresponding to data read from the digital pattern instrument using the specified channelList. If you do not want to use this parameter, pass VI_NULL. Call niDigital_GetPinName to get the name of the pin associated with an index. |
| siteNumbers | The returned site numbers that correspond to data read from the digital pattern instrument using the specified channelList. If you do not want to use this parameter, pass VI_NULL. |
| channelIndexes |
The returned index of channels corresponding to data read from the digital pattern instrument using the specified channelList. If you do not want to use this parameter, pass VI_NULL. Call niDigital_GetChannelName to get the name of the channel associated with an index. Channel indexes are one-based. |
| actualNumValues | The number of values written to the output arrays. This function always writes the same number of values to all output arrays, if they are not set to VI_NULL. |
Return value: Reports the status of the operation.
Returns the site numbers that correspond to per-site data read from the digital pattern instrument.
The function returns site numbers in the same order as values read using the niDigital_GetSitePassFail and niDigital_FetchCaptureWaveformU32 functions. Use this function to match values the previously listed functions return with site numbers.
C Function Prototype: ViStatus niDigital_GetSiteResultsSiteNumbers (ViSession vi, ViConstString siteList, ViInt32 siteResultType, ViInt32 siteNumbersBufferSize, ViInt32[] siteNumbers, ViInt32* actualNumSiteNumbers)
| Parameter | Description |
|---|---|
| vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
| siteList | Site numbers listed as a comma-delimited list of strings of form siteN, where N is the site number. |
| siteResultType |
The type of data specified in the results array. - NIDIGITAL_VAL_PASS_FAIL (3300): Get site numbers for pass/fail data. - NIDIGITAL_VAL_CAPTURE_WAVEFORM (3301): Get site numbers for capture waveforms. |
| siteNumbersBufferSize | The number of elements in the ViInt32 array you specify for siteNumbers. To determine the size of the buffer to allocate for the siteNumbers array, pass a value of 0 to the siteNumbersBufferSize parameter and a value of VI_NULL to the siteNumbers parameter. In this case, the value returned by the actualNumSiteNumbers parameter is the size of the array necessary to hold the site numbers. |
| Output | |
| siteNumbers | The returned array of site numbers that correspond to the values specified by siteResultType. |
| actualNumSiteNumbers | Number of sites written in the siteNumbers array. |
Return value: Reports the status of the operation.