RFmxInstr_IsSelfCalibrateValid
- Updated2025-10-13
- 2 minute(s) read
Returns an array to indicate which calibration steps contain valid calibration data. To omit steps with the valid calibration data from self-calibration, you can pass the Valid Steps parameter to the Steps To Omit parameter of the RFmxInstr_SelfCalibrate function. On a MIMO session, use the Selector String parameter to get the self-calibration validity for a specific MIMO port.
Syntax
int32 __stdcall RFmxInstr_IsSelfCalibrateValid(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 *selfCalibrateValid, int32 *validSteps)
Remarks
Supported devices: PXIe-5663/5663E/5665/5668
Parameters
| Name | Direction | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function. | ||||||||||||
| selectorString | [in] | char[] | This parameter specifies a Selector String comprising of a MIMO port on a MIMO session. The default value is "" (empty string). Example: "" "port::myrfsa1/0" You can use the RFmxInstr Build Port String function to build the selector string. | ||||||||||||
| selfCalibrateValid | [out] | int32 * | This parameter returns TRUE if all the calibration data is valid and FALSE if any of the calibration data is invalid. | ||||||||||||
| validSteps | [out] | int32 * | This parameter returns an array of valid steps.
|
Returns
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 RFmx function to determine if an error has occurred.
To obtain a text description of the status code and additional information about the error condition, call the RFmxInstr_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |