niHWS_Seek

NI-HWS C Function Reference

niHWS_Seek

C Function Prototype

tHWS_Status niHWS_Seek (tHWS_WfmRef wfmReference, tHWS_RelativeTo relativeTo, long offset);

Purpose

There is a single position within each waveform for both reading and writing. This function moves this position. First, the position is moved to the place in the waveform specified by the relativeTo parameter, then the offset is added.

Parameters

Name Type Description
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.
relativeTo tHWS_RelativeTo Specifies the initial placement of the read/write position prior to adding offset.

Defined Values

niHWS_Start—Before the first sample in the waveform
niHWS_End—After the last sample in the waveform
niHWS_CurrentPosition—The current sample in the waveform

offset long After the read/write position is moved according to the value of the relativeTo parameter, the value of offset is added to determine the final read/write position.


offset can be negative. Having offset as negative is useful when relativeTo is at the End of the waveform.

Return Value