niFgen_GetChannelName
ViStatus niFgen_GetChannelName (ViSession vi, ViInt32 index, ViInt32 buffersize, ViChar[] channelName);
Purpose
The function returns the channel string that is in the channel table at an index you specify.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| index | ViInt32 | Specifies a 1-based index into the channel table. |
| bufferSize | ViInt32 | Specifies the size of the buffer for the channel string. |
| Output | ||
| Name | Type | Description |
| channelName | ViConstString | Returns the channel string that is in the channel table at the index you specify.
Do not modify the contents of the channel string. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|