IviFgen_GetChannelName

CVI/LabWindows IVI Class Driver

IviFgen_GetChannelName

IviFgenBase Capability Group

C Function Prototype

ViStatus IviFgen_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 you pass 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

Inputs Type Description
vi ViSession The instrument handle that you obtain from the IviDCPwr_init or IviDCPwr_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 into the parameter name.
     
Outputs Type Description
name ViString Returns the name of the Channel specified by the index parameter.

Return Values