Skip to content

NI RFmx SpecAn Build String Functions

Alex Starche edited this page Feb 28, 2022 · 4 revisions

Build String Functions

RFmxSpecAn_BuildSignalString

int32 __stdcall RFmxSpecAn_BuildSignalString (char signalName[], char resultName[], int32 selectorStringLength, char selectorString[]);

Purpose

Creates the selector string for use with Configuration or Fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringLength and NULL for the selectorString buffer.

Parameters

Input
Name Type Description
signalName char[] Specifies the signal name for building the selector string. This input accepts the signal name with or without the "signal::" prefix.

Example:

""

"signal::sig1"

"sig1"
resultName char[] Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix.
Example:
""
"result::r1"
"r1"
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.
Output
Name Type Description
selectorString 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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildRangeString2

int32 __stdcall RFmxSpecAn_BuildRangeString2 ( char selectorString[], int32 rangeNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates selector string for use with spurious emissions (Spur) configuration or fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
rangeNumber int32 Specifies the range 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildSpurString2

int32 __stdcall RFmxSpecAn_BuildSpurString2 (char selectorString[], int32 spurNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the selector string to use with the spurious emissions (Spur) measurement results or fetch functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name, result name, and range number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. You can also pass the selectorStringOut parameter of the RFmxSpecAn_BuildRangeString2) function as an input to this function. The default value is "range0" (empty string).

Example:

"range0"

"signal::sig1/range0"

"result::r1/range0"

"signal::sig1/result::r1/range0"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
spurNumber int32 Specifies the spur 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildOffsetString2

int32 __stdcall RFmxSpecAn_BuildOffsetString2( char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[] );

Purpose

Creates the selector string to use with SEM and ACP offset configuration or fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
offsetNumber int32 Specifies the offset 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildMarkerString2

int32 __stdcall RFmxSpecAn_BuildMarkerString2 (char selectorString[], int32 markerNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the selector string to use with marker configuration or fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
markerNumber int32 Specifies the marker 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildHarmonicString2

int32 __stdcall RFmxSpecAn_BuildHarmonicString2 (char selectorString[], int32 harmonicNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the selector string to use with Harmonics configuration or fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
harmonicNumber int32 Specifies the harmonic 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildCarrierString2

int32 __stdcall RFmxSpecAn_BuildCarrierString2 (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the selector string to use with the SEM, ACP, and CHP carrier configuration or fetch attributes and functions. You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringOutLength parameter.

If you want to call this function just to get the required buffer size, you must pass 0 for selectorStringOutLength and NULL for the selectorStringOut buffer.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
carrierNumber int32 Specifies the carrier 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildIntermodString

int32 __stdcall RFmxSpecAn_BuildIntermodString (char selectorString[], int32 intermodNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the intermod string to use as the selector string with the IM configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
intermodNumber int32 Specifies the intermod 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.
selectorStringOut 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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_BuildSegmentString

int32 __stdcall RFmxSpecAn_BuildSegmentString (char selectorString[], int32 segmentNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates a selector string for use with the PAVT configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
segmentNumber int32 Specifies the segment 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.

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 RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally