Returns the list names and the corresponding selected personality type from the Personality Filter parameter. When you set the Personality Filter parameter to All, this function returns the available list names for all supported personalities.

Syntax

int32 __stdcall RFmxInstr_GetListNames(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 personalityFilter, char listNames[], int32 listNamesSize, int32 *actualListNamesSize, int32 personality[], int32 personalityArraySize, int32 *actualPersonalityArraySize)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

selectorString[in]char

Specifies a selector string. Pass an empty string.

personalityFilter[in]int32

This parameter specifies the personality filter to get the list names. You can specify one or more of the following personalities. The default value is All.

Name (Value)

Description

SpecAn (1)

Specifies the SpecAn personality.

Demod (2)

Specifies the Demod personality.

LTE (4)

Specifies the LTE personality.

GSM (8)

Specifies the GSM personality.

WCDMA (16)

Specifies the WCDMA personality.

CDMA2k (32)

Specifies the CDMA2k personality.

TDSCDMA (64)

Specifies the TD-SCDMA personality.

EVDO (128)

Specifies the EV-DO personality.

NR (256)

Specifies the NR personality.

WLAN (512)

Specifies the WLAN personality.

BT (1024)

Specifies the BT personality.

All (2147483647)

Specifies all the personalities.

listNames[in]char

This parameter returns an array of the list names.

listNamesSize[in]int32

Returns the size of the listNames array, if you pass NULL to listNames array parameter, and set the listNamesSize parameter to 0.

actualListNamesSize[out]int32 *

Returns the actual size of the listNames array, if you pass NULL to listNames array parameter, and set the listNamesSize parameter to 0.

personality[in]int32

This parameter returns an array of personalities where each entry corresponds to the personality of each list name in the List Names array.

personalityArraySize[in]int32

Specifies the size of the personality array. Set the personalityArraySize parameter to 0 to get the size of the personality array in the actualPersonalityArraySize parameter.

actualPersonalityArraySize[out]int32 *

Returns the actual size of the personality array, if you pass NULL to personality array parameter, and set the personalityArraySize parameter to 0.

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