NI DIGITAL PATTERN DRIVER Pattern Results Functions

Pattern Results Functions

• niDigital_GetSitePassFail
• niDigital_GetFailCount

niDigital_GetSitePassFail

Returns the pass or fail results for each site.

C Function Prototype: ViStatus niDigital_GetSitePassFail (ViSession vi, ViConstString siteList, ViInt32 passFailBufferSize, ViBoolean[] passFail, ViInt32* actualNumSites)

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.
passFailBufferSize	The number of elements in the ViBoolean array you specify for passFail. To determine the size of the buffer to allocate for the passFail array, pass a value of 0 to the passFailBufferSize parameter and a value of VI_NULL to the passFail parameter. In this case, the value returned by the actualNumSites parameter is the size of the array necessary to hold the pass/fail values.
Output
passFail	The returned array of pass (VI_TRUE) and fail results for the sites you specify in the siteList parameter. If sites span multiple digital pattern instruments, you must use an AND operator for the partial results for those sites returned by each instrument. If a site is disabled or not enabled for burst, the function does not return data for that site. Use the niDigital_SortSiteResultsViBoolean function to order and combine the data to match the siteList. You can also use the niDigital_GetSiteResultsSiteNumbers function to determine the order of the sites returned from this function call so that you can match the pass array with site numbers.
actualNumSites	Number of values written to the passFailBufferSize and passFail arrays.

Return value: Reports the status of the operation.

niDigital_GetFailCount

Returns the comparison fail count for pins in the channelList.

C Function Prototype: ViStatus niDigital_GetFailCount (ViSession vi, ViConstString channelList, ViInt32 bufferSize, ViInt64[] failureCount, ViInt32* actualNumRead)

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 ViInt64 array you specify for failureCount. To determine the size of the buffer to allocate for the failureCount array, pass a value of 0 to the bufferSize parameter and a value of VI_NULL to the failureCount parameter. In this case, the value returned by the actualNumRead parameter is the size of the array necessary to hold the failure counts.
Output
failureCount	Number of failures in an array. If a site is disabled or not enabled for burst, the function does not return data for that site. If you are using a list of pin names to read data from multiple instruments, use the niDigital_SortPinResultsBySiteViInt64 function to order and combine the data to match the channelList. You can also use the niDigital_GetResultsPinMapInformation function to obtain a sorted list of returned sites and channels.
actualNumRead	Number of failure count values written to the failureCount array.

Return value: Reports the status of the operation.