RFmxInstr_CheckIfListExists
- Updated2025-10-13
- 2 minute(s) read
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.
Syntax
int32 __stdcall RFmxInstr_CheckIfListExists(niRFmxInstrHandle instrumentHandle, char listName[], int32 *listExists, int32 *personality)
Parameters
| Name | Direction | Type | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray 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" | ||||||||||||||||||||||||||
| listExists | [out] | int32 * | This parameter indicates whether the list exists or not.
| ||||||||||||||||||||||||||
| personality | [out] | int32 * | This parameter indicates the personality of the list if the list exists.
|
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 RFmxInstr_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |