VTI Instruments EX1629 - Vtex1629_Get_Selfcal_Status

VTI Instruments Corp.
182 EX1629 Command Set
vtex1629_get_selfcal_status
FUNCTION PROTOTYPE
ViStatus vtex1629_get_selfcal_status (ViSession vi, ViInt32 failedChannelArraySize, ViInt32 _VI_FAR
failedChannelArray[],ViPInt32 failedChannelArrayActualSize);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
failedChannelArraySize = defines the size of the failedChannelArray[] parameter. Valid return values: 1 to 48.
failedChannelArray[] = a integer return array of the channels that failed self-calibration. Valid return values: 0 to
47.
failedChannelArrayActualSize = the actual size of the returned array failedChannelArray[] parameter. Valid
return values: 0 to 48.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns self-calibration failure status for the selected channels. To ensure that an
incomplete list is not returned, it is recommended that the failedChannelArraySize parameter be set to 48. Note
that if the failedChannelArrayActualSize parameter returns a ‘0’, all channels passed self-calibration.
EXAMPLE
ViSession instrumentHandle;
ViStatus status = VI_SUCCESS;
ViInt32 failedChannelArraySize = MAX_CHANNELS;
ViInt32 failedChannelArray[MAX_CHANNELS];
ViInt32 failedChannelArrayActualSize = 0;
status = vtex1629_get_selfcal_status(instrumentHandle,
failedChannelArraySize,
failedChannelArray,
&failedChannelArrayActualSize);