Deletes the list instance and all the list steps that you specify in the List Name parameter. When a list step is deleted, all the instances of attributes associated with the list step are also removed.

Syntax

int32 __stdcall RFmxSpecAn_DeleteList(niRFmxInstrHandle instrumentHandle, char listName[])

Remarks

Supported devices:PXIe-5840/5841/5842/5860

Parameters

NameDirectionTypeDescription
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:

"list::samplelist1"

"samplelist1"

You can use the RFmxSpecAn_BuildListString function to build the list name.

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 RFmxSpecAn_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors