ClassPrefix_GetChannelName
IVI Inherent Function
To form the CLASSPREFIX_ of the function name, use the prefix of the class driver with which you are working. For example, if you are working with the IviDmm class driver, use the prefix IviDmm_ to create the correct function name, IviDmm_GetChannelName.
C Function Prototype
ViStatus ClassPrefix_GetChannelName (ViSession vi, ViInt32 index, ViInt32 bufferSize, ViString name);
Purpose
This function returns the specific driver defined output name that corresponds to the one-based index that you specify. If the value that the user passes for the Index parameter is less than one or greater than the value of the Channel Count attribute, the function returns an empty string in the Name parameter and returns an error.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The instrument handle that you obtain from the ClassPrefix_init or ClassPrefix_InitWithOptions functions. The handle identifies a particular IVI session. |
| index | ViInt32 | A one-based index that defines which name to return. The index must be less than or equal to the Channel Count attribute. |
| bufferSize | ViInt32 | The size of the string buffer passed in to the parameter name. |
| name | ViString | Returns the name of the Channel specified by the index parameter. |