VTI Instruments EX1629 - Vtex1629_Set_Confidence_Reporting_Mode

www.vtiinstruments.com
EX1629 Command Set 245
vtex1629_set_confidence_reporting_mode
FUNCTION PROTOTYPE
ViStatus vtex1629_set_confidence_reporting_mode (ViSession vi, ViInt32 mode);
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.
mode = sets the reporting mode for confidence limit checking. Valid input values: 0 through 2.
DATA ITEM RESET VALUE
mode = VTEX1629_CONF_LIMIT_DISABLE_REPORT (0)
DESCRIPTION
This function sets the reporting mode for confidence limit checking. Valid input values for the mode parameter are
as follows:
Decimal
Value
Hex
Value
#define Symbol
mode Description
0
0x00
VTEX1629_CONF_LIMIT_DISABLE_REPORT
Reporting disabled
1
0x01
VTEX1629_CONF_LIMIT_SUMMARY_REPORT_ONLY
Summary report mode selected
2
0x02
VTEX1629_CONF_LIMIT_DETAILED_REPORT
Detailed report mode selected
If set to VTEX1629_CONF_LIMIT_DISABLE_REPORT, the EX1629 will not collect confidence limit checking
data. If set to VTEX1629_CONF_LIMIT_SUMMARY_REPORT_ONLY, an array will be created which indicates
the channels that exceeded their limits. VTEX1629_CONF_LIMIT_DETAILED_REPORT, by contrast, provides an
array that indicates if the minimum or maximum limit of a channel has been exceeded.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 mode = VTEX1629_CONF_LIMIT_SUMMARY_REPORT_ONLY;
status = vtex1629_set_confidence_reporting_mode(instrumentHandle, mode);