IviPwrMeter_IsZeroComplete
IviPwrMeterZeroCorrection Capability Group
C Function Prototype
ViStatus IviPwrMeter_IsZeroComplete (ViSession vi, ViInt32* zeroCorrectionStatus);
Purpose
This function queries the instrument to determine the status of all zero correction operations initiated by the IviPwrMeter_Zero or IviPwrMeter_ZeroAllChannels functions. This function returns the IVIPWRMETER_VAL_ZERO_COMPLETE (1) value in the Status parameter only when zero corrections are complete on all enabled channels.
If some zero correction operations are still in progress on one or more channels, this function returns the IVIPWRMETER_VAL_ZERO_IN_PROGRESS (0) value. If the driver cannot query the instrument to determine its state, the driver returns the IVIPWRMETER_VAL_ZERO_STATUS_UNKNOWN (-1) value.
Note:
This function does not check the instrument status. Typically, you call this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. You use the low-level functions to optimize one or more aspects of interaction with the instrument. If you want to check the instrument status, call the IviPwrMeter_error_query function at the conclusion of the sequence.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| zeroCorrectionStatus | ViInt32 | Returns the status of the zero correction.
This driver defines the following zero correction status: IVIPWRMETER_VAL_ZERO_COMPLETE (1) - The power meter has completed all zero correction operations. IVIPWRMETER_VAL_ZERO_IN_PROGRESS (0) - The power meter is still performing a zero correction on one or more enabled channels. IVIPWRMETER_VAL_ZERO_STATUS_UNKNOWN (-1) - The power meter cannot determine the status of the zero correction. |