niRFSA_CreateConfigurationList
- Updated2025-05-22
- 2 minute(s) read
niRFSA_CreateConfigurationList
ViStatus niRFSA_CreateConfigurationList (ViSession vi, ViConstString listName, ViInt32 numberOfListAttributes, const ViAttr* listAttributeIDs, ViBoolean setAsActiveList);
Purpose
Creates an empty configuration list for RF list mode. After a configuration list is created, enable the list using the setAsActiveList parameter. Call the niRFSA_CreateConfigurationListStep function to add steps to the active configuration list.
Supported Devices: PXIe-5644/5645/5646, PXIe-5663E/5665/5667, PXIe-5820/5830/5831/5832/5840/5841/5842, PXIe-5842 with S-parameters
Related Topics
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. |
| listName | ViConstString | Specifies the name of the configuration list. This string may not contain spaces, special characters, or punctuation marks. |
| numberOfListAttributes | ViInt32 | Specifies the number of configuration list attributes to set. |
| listAttributeIDs | const ViAttr* | Specifies the attributes that you intend to change between configuration list steps. Calling the
niRFSA_CreateConfigurationList function allocates space for each of the configuration list properties. When you use set one of the configuration list attributes, that attribute is set as one of the configuration list steps. Specify which configuration list step is being configured using the NIRFSA_ATTR_ACTIVE_CONFIGURATION_LIST attribute. You can include the following attributes in your configuration list based on your device: |
| setAsActiveList | ViBoolean | Sets this list as the active configuration list when this parameter is set to VI_TRUE. |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | 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 NI-RFSA 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 niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||