niHWS_GetWfmName
C Function Prototype
tHWS_Status niHWS_GetWfmName (tHWS_FileHandle fileHandle, const char groupName[], long wfmIndex, long wfmNameSize, char wfmName[]);
Purpose
Returns the name of a waveform in a group. The name of a waveform is necessary for getting a reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.
Parameters
| Name | Type | Description |
|---|---|---|
| fileHandle | tHWS_FileHandle | Refers to an open HWS file. |
| groupName | const char[] | The name of the group. Groups are identified by name for purposes of setting and
getting group attributes.
If only one group is in the file, groupName can be NULL or the empty string. |
| wfmIndex | long | A number such that 0  wfmIndex <
numberOfWaveforms
where numberOfWaveforms is obtained by calling niHWS_GetNumberOfWaveforms. If five waveforms are in a group, their waveform indices are 0 through 4. The only use for the wfmIndex parameter is to obtain the name of a waveform. |
| wfmNameSize | long | Specifies the number of characters in the wfmName parameter.
If this parameter is set to 0 and no error occurs, the actual number of characters, including the end of string termination character, in the wfmName are returned in the status parameter. |
| wfmName | char[] | The name of the waveform specified by the wfmIndex parameter. The name of a waveform is necessary for getting a reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data. If wfmName is not NULL, up to wfmNameSize characters are copied into it. If the actual size of the waveform name is larger, an error is returned along with the portion of the name that fits. |