IviPwrMeter_QueryResultRangeType
IviPwrMeterBase Capability Group
C Function Prototype
ViStatus IviPwrMeter_QueryResultRangeType (ViSession vi, ViReal64 measurementValue, ViInt32* rangeType);
Purpose
This function takes a measurement value that is returned from one of the Fetch, Fetch Channel, Read, or Read Channel functions and determines if the value is a valid measurement value or a value indicating that an out-of-range condition occurred.
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 |
| measurementValue | ViReal64 | Pass the measurement value that you obtain from one of the Fetch or Read functions. The driver tests this value to determine if the value is a valid measurement value or a value indicating an out-of-range condition occurred.
Default Value: 0.0 |
| rangeType | ViInt32 | Returns whether the measurement value is a valid measurement or a value indicating that the power meter encountered an out-of-range condition.
This driver defines the following range type: IVIPWRMETER_VAL_IN_RANGE (0) - The measurement is within the current range limits. IVIPWRMETER_VAL_UNDER_RANGE (-1) - The measurement is below the current lower range limits. IVIPWRMETER_VAL_OVER_RANGE (1) - The measurement is above the current upper range limits. |