IviPwrMeter_Abort
IviPwrMeterBase Capability Group
C Function Prototype
ViStatus IviPwrMeter_Abort (ViSession vi);
Purpose
This function aborts all previously initiated measurements and returns the power meter to the Idle state. You initiate measurement with the IviPwrMeter_Initiate function.
Notes:
(1) 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.
(2) If the instrument cannot abort an initiated acquisition, this function returns the IVI_ERROR_FUNCTION_NOT_SUPPORTED error.
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 |