RFmxInstr_DeleteAllExternalAttenuationTables
- Updated2025-04-08
- 2 minute(s) read
Deletes all the external attenuation tables in the calibration plane specified by the Selector String parameter. On a MIMO session, this function deletes all the external attenuation tables for the specified MIMO port.
Syntax
int32 __stdcall RFmxInstr_DeleteAllExternalAttenuationTables(niRFmxInstrHandle instrumentHandle, char selectorString[])
Remarks
Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860
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 the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. The default value is "" (empty string). If you specify "calplane::all", all the calibration planes are deleted. On a MIMO session, the default "" (empty string) deletes all the external attenuation tables for all MIMO Ports. To delete an external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0". Note Example:For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::<calplanename>/port::<portname>". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::<calplanename>/port::<devicename>/<channelnumber>/<portname>". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.</portname></channelnumber></devicename></calplanename></portname></calplanename> "" "calplane::plane0" "calplane::all" "calplane::plane0/port::if0" "port::if0" "calplane::plane0/port::all" "calplane::all/port::all" "calplane::plane0/port::myrfsa1/0" "calplane::plane0/port::myrfsa1/0, port::myrfsa2/0" "calplane::plane0/port::myrfsa1/0/if0" |
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 |