niRFSG_GetChannelName
C Function Prototype
ViStatus niRFSG_GetChannelName (ViSession vi, ViInt32 Index, ViInt32 BufferSize, ViChar Channel_Name[]);
Purpose
Returns the channel string that is in the channel table at an index you specify.
Supported Devices:
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. Default Value: None |
| 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 |
| Channel_Name | ViChar[] | Returns a channel string from the channel table at the index you specify in the Index parameter. 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. Examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows:
|