RFmxInstr_GetSignalConfigurationNames
- Updated2025-04-08
- 2 minute(s) read
Returns the signal names and the corresponding selected personality type from the Personality Filter parameter.
Syntax
int32 __stdcall RFmxInstr_GetSignalConfigurationNames(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 personalityFilter, char signalNames[], int32 signalNamesSize, int32 *actualSignalNamesSize, int32 personality[], int32 personalityArraySize, int32 *actualPersonalityArraySize)
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. | ||||||||||||||||||||||||||
| selectorString | [in] | char | Specifies a selector string. Pass an empty string. | ||||||||||||||||||||||||||
| personalityFilter | [in] | int32 | This parameter specifies the personality filter to get the signal configuration names. You can specify one or more of the following personalities. The default value is All.
| ||||||||||||||||||||||||||
| signalNames | [in] | char | This parameter returns an array of the signal names. | ||||||||||||||||||||||||||
| signalNamesSize | [in] | int32 | Specifies the size of the signalNames array. Set the signalNamesSize parameter to 0 to get the size of the signalNames array in the actualSignalNamesSize parameter. | ||||||||||||||||||||||||||
| actualSignalNamesSize | [out] | int32 * | Returns the actual size of the signalNames array, if you pass NULL to signalNames array parameter, and set the signalNamesSize parameter to 0. | ||||||||||||||||||||||||||
| personality | [in] | int32 | This parameter returns an array of personalities where each entry corresponds to the personality of each signal name in the Signal 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 |