niHWS_GetGroupName

NI Digital Waveform Generator/Analyzer Help

Edition Date: June 2013

Part Number: 370520P-01

»View Product Info
Download Help (Windows Only)

C Function Prototype

tHWS_Status niHWS_GetGroupName (tHWS_FileHandle fileHandle, long groupIndex, long groupNameSize, char groupName[]);

Purpose

Returns the name of a group in an NI-HWS file. Groups are identified by name for purposes of setting and getting group attributes.

Parameters

Name Type Description
fileHandle tHWS_FileHandle Refers to an open HWS file.
groupIndex long A number such that 0 groupIndex < numberOfGroups

where

numberOfGroups is obtained by calling niHWS_GetNumberOfGroups. If five groups are in a file, their group indices are 0 through 4. The only use for the groupIndex parameter is to obtain the name of a group. Groups are identified by name for purposes of setting and getting group attributes.

groupNameSize long Specifies the number of characters in the groupName.

If this parameter is set to 0 and there is no error, the actual number of characters, including the end of string termination character, in the groupName are returned in the status parameter.

groupName char[] The name of the group specified by the groupIndex parameter. Groups are identified by name for purposes of setting and getting group attributes.

If groupName is not NULL, up to groupNameSize characters are copied into it.

If the actual size of groupName is larger, an error is returned along with the portion of the name that fits.

Return Value

WAS THIS ARTICLE HELPFUL?

Not Helpful