collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_GetChannelName Function


Channel See Also



This function returns the physical channel identifier that corresponds to the one-based index that the user specifies. If the value that the user passes for the ChannelIndex parameter is less than one or greater than the value of the Channel Count attribute, the function returns an empty string in the ChannelName parameter and returns an error.

Function Tree Node: \Boonton55xxx\Configuration\Channel\Get Channel Name

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_GetChannelName(
 ViSession Vi,
 ViInt32 Index,
 ViInt32 NameBufferSize,
 ViChar[] Name
);

Parameters

Vi

The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session.

Index

A one-based index that defines which name to return.

NameBufferSize

The number of bytes in the ViChar array that the user specifies for the ChannelName parameter.

Name

The buffer into which the function returns the channel name that corresponds to the index the user specifies. The caller may pass VI_NULL for this parameter if the ChannelNameBufferSize parameter is 0.

Return Value

 

Success or failure code.

collapse_allRequirements

Supported Models

All supported

collapse_allSee Also

Reference

Channel

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.