Skip to content

NI RFmx Instruments Utility

Alex Starche edited this page Mar 1, 2022 · 1 revision

Utility

RFmxInstr_WaitForAcquisitionComplete

int32 __stdcall RFmxInstr_WaitForAcquisitionComplete (niRFmxInstrHandle instrumentHandle, float64 timeout);

Purpose

Waits and blocks the data flow until the acquisition is complete. This function is typically called after a specific initiate function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
timeout float64 Specifies the time to wait for an ongoing acquisition to complete before returning a timeout error. A value of -1 specifies that the function waits indefinitely for acquisition to complete. This value is expressed in seconds.

Return Value

Name Type Description
status 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.

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_CheckAcquisitionStatus

int32 __stdcall RFmxInstr_CheckAcquisitionStatus (niRFmxInstrHandle instrumentHandle, int32* acquisitionDone);

Purpose

Checks the status of the acquisition. Use this function to check for any errors that may occur during acquisition, or to check whether RFmx has completed the acquisition operation.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
Output
Name Type Description
acquisitionDone int32* Indicates whether the acquisition is complete.

Return Value

Name Type Description
status 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.

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_ResetToDefault

int32 __stdcall RFmxInstr_ResetToDefault (niRFmxInstrHandle instrumentHandle);

Purpose

Resets the RFmxInstr attributes to their default values. This function disables all the calibration planes.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

Return Value

Name Type Description
status 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.

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_ResetDriver

int32 __stdcall RFmxInstr_ResetDriver (niRFmxInstrHandle instrumentHandle);

Purpose

Restores the NI-RFSA driver state to a default state to avoid RFmx using any hardware or driver state that was set by the RF toolkits or other custom NI-RFSA code. Use this function when you switch back to using RFmx to perform measurements after you have used the NI-RFSA handle to perform measurements with RF toolkits or you have used other custom NI-RFSA code. Unlike the RFmxInstr_ResettoDefault) function, the RfmxInstr Reset Driver function does not reset RFmx attributes configured on the RFmx session. Hence, you do not need to set RFmx attributes again when switching back to RFmx measurements. Refer to RFmx SpecAn CHP - WCDMA ModAcc - CHP Example (LabVIEW) for more information about using RFmx to perform measurements.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

Return Value

Name Type Description
status 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.

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_GetNIRFSASession

int32 __stdcall RFmxInstr_GetNIRFSASession (niRFmxInstrHandle instrumentHandle, uInt32 *niRfsaSession);

Purpose

Returns the NI-RFSA driver session used by the RFmx.

Note Do not close the NI-RFSA driver session before calling the RFmxInstr_Close function. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
Output
Name Type Description
niRfsaSession uInt32* Specifies the RFSA session for the device.

Return Value

Name Type Description
status 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.

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_InitializeFromNIRFSASession

int32 __stdcall RFmxInstr_InitializeFromNIRFSASession (uInt32 NIRFSASession, niRFmxInstrHandle *handleOut);

Purpose

Initializes an RFmx session from an existing NI-RFSA session. This function resets all the NI-RFSA attributes to their default values and stops export of all external signals and events. This function also takes in an active NI-RFSA session and returns an RFmx Handle that identifies the device in all the subsequent RFmx functions.

Do not close the NI-RFSA driver session before calling the RFmxInstr_Close function. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior.

Closing the RFmx session will not close the NI-RFSA driver session.

Parameters

Input
Name Type Description
NIRFSASession uInt32 Identifies the NI-RFSA session.
Output
Name Type Description
handleOut niRFmxInstrHandle* Returns an RFmx instrument session.

Return Value

Name Type Description
status 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.

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_CheckIfSignalConfigurationExists

int32 __stdcall RFmxInstr_CheckIfSignalConfigurationExists( niRFmxInstrHandle instrumentHandle, char signalName[], int32* signalConfigurationExists, int32* personality );

Purpose

Returns whether the signal you specify in the signalName parameter exists, and also returns the corresponding personality type of the signal, if the signal exists. This function does not support an empty ("") signal name.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
signalName char[] Specifies the name of the signal. This parameter accepts the signal name with or without the "signal::" prefix.

Example:

"signal::sig1"

"sig1"
personality int32* Indicates the personality of the signal if the signal exists and if this parameter is not set to NULL.
RFMXINSTR_VAL_PERSONALITY_NONE (0) Specifies that a signal does not exist.
RFMXINSTR_VAL_PERSONALITY_SPECAN (0x00000001) Specifies the SpecAn personality.
RFMXINSTR_VAL_PERSONALITY_DEMOD (0x00000002) Specifies the Demod personality.
RFMXINSTR_VAL_PERSONALITY_LTE (0x00000004) Specifies the LTE personality.
RFMXINSTR_VAL_PERSONALITY_GSM (0x00000008) Specifies the GSM personality.
RFMXINSTR_VAL_PERSONALITY_WCDMA (0x00000010) Specifies the WCDMA personality.
RFMXINSTR_VAL_PERSONALITY_CDMA2k (0x00000020) Specifies the CDMA2k personality.
RFMXINSTR_VAL_PERSONALITY_TDSCDMA (0x00000040) Specifies the TD-SCDMA personality.
RFMXINSTR_VAL_PERSONALITY_EVDO (0x00000080) Specifies the EV-DO personality.
RFMXINSTR_VAL_PERSONALITY_NR (0x00000100) Specifies the NR personality.
RFMXINSTR_VAL_PERSONALITY_WLAN (0x00000200) Specifies the WLAN personality.
RFMXINSTR_VAL_PERSONALITY_BT (0x00000400) Specifies the BT personality.
RFMXINSTR_VAL_PERSONALITY_ALL (0x7FFFFFFF) Specifies all the personalities.
Output
Name Type Description
signalConfigurationExists int32* Indicates whether the signal exists or not.
FALSE Indicates that the signal does not exist.
TRUE Indicates that the signal exists.

Return Value

Name Type Description
status 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.

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_CheckIfListExists

int32 __stdcall RFmxInstr_CheckIfListExists (niRFmxInstrHandle instrumentHandle, char listName[], int32* listExists, int32* personality);

Purpose

Returns whether the list you specify in the listName parameter exists, and also returns the corresponding personality of the list, if the list exists. This function does not support an empty ("") list name.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
listName char[] Specifies the name of the list. This parameter accepts the list name with or without the "list::" prefix.


example:
"list::samplelist1"
"samplelist1"
Output
Name Type Description
listExists int32* Indicates whether the list exists or not.
FALSE Indicates that the list does not exist.
TRUE Indicates that the list exists.
personality int32* Indicates the personality of the list if the list exists.

Return Value

Name Type Description
status 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.

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_SaveAllConfigurations

int32 __stdcall RFmxInstr_SaveAllConfigurations (niRFmxInstrHandle instrumentHandle, char filePath[]);

Purpose

Saves all the configured attributes in the RFmx session to a file in the specified file path. Use this function to save the current state of the RFmx session. On a MIMO session, this function saves all the configured properties for the specified MIMO port.

Note Reference waveforms and external attenuation tables are not saved by this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
filePath char[] Specifies the complete path to the technical data management streaming (TDMS) file to which the configurations are to be saved.

Return Value

Name Type Description
status 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.

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_LoadAllConfigurations

int32 __stdcall RFmxInstr_LoadAllConfigurations (niRFmxInstrHandle instrumentHandle, char filePath[], int32 loadRFInstrConfiguration);

Purpose

Loads the attributes of an RFmx session saved in a file. This file can be generated using RFmxInstr_SaveAllConfigurations) function, or the RFmx Soft Front Panel.

Note If the file contains a named signal configuration which is already present in the session, then this function will return an error. It is recommended to call the RFmxInstr_ResetEntireSession function to delete all the named signal configurations in the session.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
filePath char[] Specifies the complete path to the technical data management streaming (TDMS) file from which the configurations are to be loaded.
loadRFInstrConfiguration int32 Specifies whether to load RFmxInstr attributes saved in the file.

Return Value

Name Type Description
status 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.

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_ResetEntireSession

int32 __stdcall RFmxInstr_ResetEntireSession (niRFmxInstrHandle instrumentHandle);

Purpose

Deletes all the named signal configurations in the session and resets all attributes for the default signal instances of already loaded personalities in the session. This function disables all the calibration planes.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

Return Value

Name Type Description
status 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.

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_ResetAttribute

int32 __stdcall RFmxInstr_ResetAttribute (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 attributeID);

Purpose

Resets an attribute that you specify in the attributeID parameter to default values.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the selector string for the attribute being reset. Refer to the selector string) topic for more information about configuring the selector string.
attributeID int32 Pass the ID of an attribute.

Return Value

Name Type Description
status 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.

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_GetSignalConfigurationNames

int32 __stdcall RFmxInstr_GetSignalConfigurationNames( niRFmxInstrHandle instrumentHandle, char selectorString[], int32 personalityFilter, char signalNames[], int32 signalNamesSize, int32* actualSignalNamesSize, int32 personality[], int32 personalityArraySize, int32* actualPersonalityArraySize );

Purpose

Returns the signal names and corresponding personality type, for the personality type selected in the personalityFilter parameter.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies a selector string. Pass an empty string.
personalityFilter char[] Specifies the personality filter to get the signal configuration names. You can specify one or more of the following personalities. The default value is RFMXINSTR_VAL_PERSONALITY_ALL.
RFMXINSTR_VAL_PERSONALITY_SPECAN (0x00000001) Specifies the SpecAn personality.
RFMXINSTR_VAL_PERSONALITY_DEMOD (0x00000002) Specifies the Demod personality.
RFMXINSTR_VAL_PERSONALITY_LTE (0x00000004) Specifies the LTE personality.
RFMXINSTR_VAL_PERSONALITY_GSM (0x00000008) Specifies the GSM personality.
RFMXINSTR_VAL_PERSONALITY_WCDMA (0x00000010) Specifies the WCDMA personality.
RFMXINSTR_VAL_PERSONALITY_CDMA2k (0x00000020) Specifies the CDMA2k personality.
RFMXINSTR_VAL_PERSONALITY_TDSCDMA (0x00000040) Specifies the TD-SCDMA personality.
RFMXINSTR_VAL_PERSONALITY_EVDO (0x00000080) Specifies the EV-DO personality.
RFMXINSTR_VAL_PERSONALITY_NR (0x00000100) Specifies the EV-DO personality.
RFMXINSTR_VAL_PERSONALITY_WLAN (0x00000200) Specifies the EV-DO personality.
RFMXINSTR_VAL_PERSONALITY_BT (0x00000400) Specifies the EV-DO personality.
RFMXINSTR_VAL_PERSONALITY_ALL (0x7FFFFFFF) Specifies all the personalities.

Example:

To get all the signal names of SpecAn, the personalityFilter parameter should be RFMXINSTR_VAL_PERSONALITY_SPECAN.
To get the signal names of SpecAn and LTE, the personalityFilter parameter should be RFMXINSTR_VAL_PERSONALITY_SPECAN and RFMXINSTR_VAL_PERSONALITY_LTE.
To get the signal names of all personalities, the personalityFilter parameter should be RFMXINSTR_VAL_PERSONALITY_ALL.
signalNamesSize int32 Specifies the size of the signalNames array. Set the signalNamesSize parameter to 0 to get the size of the signalNames array in the actualSignalNamesSize parameter.
personalityArraySize int32 Specifies the size of the personality array. Set the personalityArraySize parameter to 0 to get the size of the personality array in the actualPersonalityArraySize parameter.
Output
Name Type Description
signalNames char[] Returns the comma delimited signal names.
actualSignalNamesSize int32* Returns the actual size of the signalNames array, if you pass NULL to signalNames array parameter, and set the signalNamesSize parameter to 0.
personality int32[] Returns an array of personalities where each entry corresponds to the personality of each signal name in the signalNames array.
actualPersonalityArraySize int32* Returns the actual size of the personality array, if you pass NULL to personality array parameter, and set the personalityArraySize parameter to 0.

Return Value

Name Type Description
status 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.

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_GetListNames

int32 __stdcall RFmxInstr_GetListNames (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 personalityFilter, char listNames[], int32 listNamesSize, int32* actualListNamesSize, int32 personality[], int32 personalityArraySize, int32* actualPersonalityArraySize);

Purpose

Returns the list names and the corresponding selected personality type from the personalityFilter parameter. When you set the personalityFilter parameter to all, this function returns the available list names for all supported personalities.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies a selector string. Pass an empty string.
personalityFilter int32 Specifies the personality filter to get the list names. You can specify one or more of the following personalities.
listNames char[] Returns an array of the list names.
listNamesSize int32 Specifies the size of the listNames array. Set the listNamesSize parameter to 0 to get the size of the listNames array in the actuallistNamesSize parameter.
personalityArraySize int32 Specifies the size of the personality array. Set the personalityArraySize parameter to 0 to get the size of the personality array in the actualPersonalityArraySize parameter.
Output
Name Type Description
actualListNamesSize int32* Returns the actual size of the listNames array, if you pass NULL to listNames array parameter, and set the listNamesSize parameter to 0.
personality int32[] Returns an array of personalities where each entry corresponds to the personality of each list name in the listNames array.
actualPersonalityArraySize int32* Returns the actual size of the personality array, if you pass NULL to personality array parameter, and set the personalityArraySize parameter to 0.

Return Value

Name Type Description
status 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.

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_GetAvailablePorts

int32 __stdcall RFmxInstr_GetAvailablePorts (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 arraySize, char availablePorts[]);

Purpose

Fetches the list of ports available for use based on your instrument configuration. On a MIMO session, this function fetches all the ports for the initialized MIMO ports.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Identifies the channel to which the settings must be applied. Specify an empty string as the value of this parameter.
arraySize int32 Specifies the size of the array.
Output
Name Type Description
availablePorts char[] Returns a list of available ports.

Return Value

Name Type Description
status 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.

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

MIMO

RFmxInstr_GetNIRFSASessionArray

int32 __stdcall RFmxInstr_GetNIRFSASessionArray (niRFmxInstrHandle instrumentHandle, uInt32 *niRfsaSession);

Purpose

Returns the NI-RFSA driver sessions used by the RFmx.

Note Do not close the NI-RFSA driver sessions before calling the RFmxInstr_Close function. Closing the NI-RFSA driver sessions before closing RFmx session would lead to unpredictable behavior.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
niRfsaSession uInt32* Specifies the NI-RFSA sessions for the device.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status 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.

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_InitializeFromNIRFSASessionArray

int32 __stdcall RFmxInstr_InitializeFromNIRFSASessionArray (uInt32 NIRFSASession, niRFmxInstrHandle *handleOut);

Purpose

Initializes an RFmx session from an existing NI-RFSA sessions. This function resets all the NI-RFSA attributes to their default values and stops export of all external signals and events. This function also takes in an active NI-RFSA sessions and returns an RFmx Handle that identifies the devices in all the subsequent RFmx functions.

Do not close the NI-RFSA driver sessions before calling the RFmxInstr_Close function. Closing the NI-RFSA driver sessions before closing RFmx session would lead to unpredictable behavior.

Closing the RFmx session will not close the NI-RFSA driver sessions.

Parameters

Input
Name Type Description
NIRFSASession uInt32 Identifies the NI-RFSA sessions.
numberOfNIRFSASessions int32 Specifies the number of NI-RFSA sessions.
Output
Name Type Description
handleOut niRFmxInstrHandle* Returns an RFmx instrument session.

Return Value

Name Type Description
status 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.

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

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