RFmxInstr_BuildPortString2
- Updated2025-04-08
- 2 minute(s) read
Creates the port string to use as the selector string with External Attenuation Table functions. On a MIMO session, this function can be used to build port string to use as a selector string for configuring or reading port-specific properties and external attenuation table functions.
Syntax
int32 __stdcall RFmxInstr_BuildPortString2(char selectorString[], char portName[], char deviceName[], int32 channelNumber, int32 selectorStringOutLength, char selectorStringOut[])
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| selectorString | [in] | char | Specifies the calibration plane string when used for building port string for the external attenuation table functions. If you do not specify the calibration plane string, the default calibration plane instance is used. |
| portName | [in] | char | Specifies the port for building the selector string. |
| deviceName | [in] | char | Specifies the device name for building the selector string. |
| channelNumber | [in] | int32 | Specifies the channel number for building the selector string. |
| selectorStringOutLength | [in] | int32 | Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0. |
| selectorStringOut | [out] | char | Returns the selector string created by this function. You can pass NULL for this parameter if selectorStringLength is set to 0, which will return the minimum buffer size required to create the signal string. If the selectorString buffer is not large enough to build the signal string, the function returns an error. |
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 |