niRFSG_GetMaxSettablePower
- Updated2024-05-08
- 1 minute(s) read
niRFSG_GetMaxSettablePower
C Function Prototype
ViStatus niRFSG_GetMaxSettablePower (ViSession vi, ViReal64 maxSettablePower);
Purpose
Returns the maximum settable output power level for the current configuration.
Supported Devices: PXIe-5830/5831/5832/5840/5841/5842
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| Output | ||
| Name | Type | Description |
| maxSettablePower | ViReal64 | Returns maximum settable power level in dBm. |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows:
|