RFmxLTE_DeleteList
- Updated2024-10-14
- 1 minute(s) read
RFmxLTE_DeleteList
int32 __stdcall RFmxLTE_DeleteList (niRFmxInstrHandle instrumentHandle, char listName[]);
Purpose
Deletes the list instance and all the list steps that you specify in the listName parameter. When a list step is deleted, all the instances of attributes associated with the list step are also removed.
supported devices : PXIe-5840/5841
Parameters
| Input | ||
| Name | Type | Description |
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize 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" You can use the RFmxLTE_BuildListString function to build the list name. |
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 RFmxLTE_GetError function. The general meaning of the status code is as follows:
|
||||||||