NI RFmx Instruments Build String

Build String

• RFmxInstr_BuildPortString2
• RFmxInstr_BuildCalibrationPlaneString
• RFmxInstr_BuildLOString
• RFmxInstr_BuildModuleString
• RFmxInstr_BuildInstrumentString

RFmxInstr_BuildPortString2

int32 __stdcall RFmxInstr_BuildPortString2 (char selectorString[], char portName[], char deviceName[], int32 channelNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

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.

Parameters

Input
Name	Type	Description
selectorString	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. example: "" "calplane::plane0" You can use the RFmxInstr_BuildCalibrationPlaneString) to build the selector string.
portName	char[]	Specifies the port for building the selector string.
deviceName	char[]	Specifies the device name for building the selector string.
channelNumber	int32	Specifies the channel number for building the selector string.
selectorStringOutLength	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.
Output
Name	Type	Description
selectorStringOut	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.

Return Value

Name	Type	Description
statusOrRequiredSize	int32	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. When the statusOrRequiredSize return value returns the buffer size, the status code is not returned. 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

RFmxInstr_BuildCalibrationPlaneString

int32 __stdcall RFmxInstr_BuildCalibrationPlaneString (char calibrationPlaneName[], int32 selectorStringLength, char selectorString[]);

Purpose

Creates the selector string to use with External Attenuation Table functions.

Parameters

Input
Name	Type	Description
calibrationPlaneName	char[]	Specifies the calibration plane name for building the selector string. This input accepts the calibration plane name with or without the "calplane::" prefix. example: "" "calplane::plane0" "plane0"
selectorStringLength	int32	Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
selectorString	char[]	Returns the selector string created by this function.

Return Value

Name	Type	Description
statusOrRequiredSize	int32	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. When the statusOrRequiredSize return value returns the buffer size, the status code is not returned. 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

RFmxInstr_BuildLOString

int32 __stdcall RFmxInstr_BuildLOString (char selectorString[], int32 LOIndex, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the LO string to use as the selector string for LO related attributes.

Parameters

Input
Name	Type	Description
selectorString	char[]	Specifies the selector string. example: ""
LOIndex	int32	Specifies the LO index for building the selector string.
selectorStringOutLength	int32	Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
Output
Name	Type	Description
selectorStringOut	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.

Return Value

Name	Type	Description
statusOrRequiredSize	int32	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. When the statusOrRequiredSize return value returns the buffer size, the status code is not returned. 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

RFmxInstr_BuildModuleString

int32 __stdcall RFmxInstr_BuildModuleString (char selectorString[], char moduleName[], int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Configures the Module string to use as the Selector String) for reading temperature of specific modules of the device.

Parameters

Input
Name	Type	Description
selectorString	char[]	Specifies the selector string. example: ""
moduleName	char[]	Specifies the module for which you want the temperature to be read.
selectorStringOutLength	int32	Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
Output
Name	Type	Description
selectorStringOut	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.

Return Value

Name	Type	Description
statusOrRequiredSize	int32	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. When the statusOrRequiredSize return value returns the buffer size, the status code is not returned. 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

RFmxInstr_BuildInstrumentString

int32 __stdcall RFmxInstr_BuildInstrumentString (char selectorString[], int32 LOIndex, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the instrument string to use as the Selector String for reading the recommended settings.

Parameters

Input
Name	Type	Description
selectorString	char[]	Specifies the selector string. example: ""
instrumentNumber	int32	Specifies the instrument number for which you want the recommended settings to be read.
selectorStringOutLength	int32	Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
Output
Name	Type	Description
selectorStringOut	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.

Return Value

Name	Type	Description
statusOrRequiredSize	int32	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. When the statusOrRequiredSize return value returns the buffer size, the status code is not returned. 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