RFmxPulse_GetAllNamedResultNames
- Updated2024-10-14
- 1 minute(s) read
RFmxPulse_GetAllNamedResultNames
int32 __stdcall RFmxPulse_GetAllNamedResultNames( niRFmxInstrHandle instrumentHandle, char selectorString[], char resultNames[], int32 resultNamesBufferSize, int32* actualResultNamesSize, int32* defaultResultExists );
Purpose
Returns all the named result names of the signal that you specify in the Selector String parameter.
Parameters
| Input | ||
| Name | Type | Description |
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxPulse_Initialize function. |
| selectorString | char[] | Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used. Example: "signal::sig1" You can use the RFmxPulse_BuildSignalString function to build the selector string. |
| resultNamesBufferSize | int32 | Specifies the size of the resultNames array. Set the resultNamesBufferSize parameter to 0 to get the size of the resultNames array in the return value. |
| Output | ||
| Name | Type | Description |
| resultNames | char[] | Returns the comma delimited result names. |
| actualResultNamesSize | int32* | Returns the actual size of the resultNames array, if you pass NULL to resultNames array parameter and set the resultNamesBufferSize parameter to 0. |
| defaultResultExists | int32* | Indicates whether the default result exists. |
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 RFmxPulse_GetError function. The general meaning of the status code is as follows:
|
||||||||