Utility
- Updated2025-10-13
- 3 minute(s) read
Groups
Group members
| Name | Description |
|---|---|
| RFmxInstr_CheckAcquisitionStatus | 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. |
| RFmxInstr_CheckIfListExists | Returns whether the list you specify in the List Name parameter exists, and also returns the corresponding personality of the list, if the list exists. This function does not support an empty ("") list name. |
| RFmxInstr_CheckIfSignalConfigurationExists | Returns whether the signal you specify in the Signal Name parameter exists, and also returns the corresponding personality of the signal, if the signal exists. This function does not support an empty ("") signal name. |
| RFmxInstr_FetchRawIQData | Fetches I/Q data from a single record in an acquisition. |
| RFmxInstr_FetchRawIQDataSplit | Fetches I/Q data from a single record in an acquisition. |
| RFmxInstr_GetAvailablePaths | Fetches the list of paths available for use based on your instrument configuration. On a MIMO session, this function fetches all the paths for the initialized MIMO paths. |
| RFmxInstr_GetAvailablePorts | 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. |
| RFmxInstr_GetListNames | Returns the list names and the corresponding selected personality type from the Personality Filter parameter. When you set the Personality Filter parameter to All, this function returns the available list names for all supported personalities. |
| RFmxInstr_GetNIRFSASession | Returns the NI-RFSA driver session used by 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. |
| RFmxInstr_GetSignalConfigurationNames | Returns the signal names and the corresponding selected personality type from the Personality Filter parameter. |
| RFmxInstr_Initialize | Creates an RFmx session to the signal/network analyzer you specify through the Resource Name parameter, and returns an Instrument Handle Out that identifies this device in all subsequent RFmx functions. Note Enabling the SFP (Soft Front Panel) debug has a performance impact. For best performance, NI recommends disabling SFP debug. SFP debug can be enabled/disabled from either the RF Signal Analyzer panel in InstrumentStudio, the RFSA Soft Front Panel, or the RFmx Debug Configuration Utility. |
| RFmxInstr_InitializeFromNIRFSASession | Initializes an RFmx session from an existing NI-RFSA session. This function resets all NI-RFSA attributes to their default values and stops export of all the 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 subsequent RFmx functions. Note |
| RFmxInstr_LoadConfigurations | Loads the attributes of an RFmx session saved in a file. This file can be generated using RFmxInstr_SaveAllConfigurations function or using the RF Signal Analyzer panel in InstrumentStudio. |
| RFmxInstr_ResetAttribute | Resets an attribute that you specify in the attributeID parameter to default values. |
| RFmxInstr_ResetDriver | 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. |
| RFmxInstr_ResetEntireSession | Deletes all the named signal in the session and resets all attributes for the default signal instances of already loaded personalities in the session. |
| RFmxInstr_ResetToDefault | Resets the RFmxInstr attributes to their default values. |
| RFmxInstr_SaveAllConfigurations | 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 attributes for the specified MIMO port. |
| RFmxInstr_WaitForAcquisitionComplete | Waits and blocks the data flow until the acquisition is complete. This function is typically called after a specific initiate function. |
Attachments
None