niHWS_GetWfmReference

NI-HWS C Function Reference

niHWS_GetWfmReference

C Function Prototype

tHWS_Status niHWS_GetWfmReference (tHWS_FileHandle fileHandle, const char groupName[], const char wfmName[], tHWS_WfmRef* wfmReference);

Purpose

Returns a reference to an existing 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, this parameter can be NULL or the empty string.

wfmName const char[] The name of the waveform. If there is only one waveform in the group, the waveform name is optional (this parameter can be NULL or the empty string). Otherwise, you must supply the waveform name.
wfmReference tHWS_WfmRef* A reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.

Return Value