RFmxNR_CreateList
- Updated2025-04-08
- 1 minute(s) read
Creates a new list instance. Call the RFmxNR_CreateListStep function to add steps to the list. Alternatively, you can also specify the number of list steps using the RFMXNR_ATTR_NUMBER_OF_STEPS attribute.
Syntax
int32 __stdcall RFmxNR_CreateList(niRFmxInstrHandle instrumentHandle, char listName[])
Remarks
Supported devices:PXIe-5840/5841/5842/5860
Parameters
Name | Direction | Type | Description |
---|---|---|---|
instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function. |
listName | [in] | char | This parameter specifies the name of the list. This parameter accepts the list name with or without the "list::" prefix. Example: |
Returns
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 RFmxNR_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |