niHWS_RetrieveDigitalWfm2DU32

NI Digital Waveform Generator/Analyzer Help

Edition Date: June 2013

Part Number: 370520P-01

»View Product Info
Download Help (Windows Only)

Specific Function

C Function Prototype

tHWS_Status niHWS_RetrieveDigitalWfm2DU32  (const char filePath[], double* rate, long wfmBufferSize, unsigned long* wfmBuffer, long* numRowsInWfm, long* numSamplesPerRowInWfm);

Purpose

Retrieves the digital waveform samples as a two-dimensional array of 32-bit unsigned integers (U32) from the file specified.

If there are multiple waveforms in the file, use the low-level functions to retrieve them.

Parameters

Name Type Description
filePath const char[] Specifies the path and filename of the HWS file to create or open. The .hws extension is typically used for NI-HWS files, although using this extension is optional.
rate double* The rate of the Sample clock used to capture the waveform.
wfmBufferSize long Specifies how many samples to read into the wfmBuffer.

If the wfmBufferSize is 0, the number of samples in the waveform is returned in the numSamplesPerRowInWfm parameter and the number of rows in the waveform is returned in the numRowsInWfm parameter.

wfmBuffer unsigned long* Contains the data for the waveform. This array must be large enough to contain at least the amount of data indicated by the value assigned to the wfmBufferSize times the number of rows in the waveform.
numRowsInWfm long* Reports the number of rows the waveform.
numSamplesPerRowInWfm long* Reports the number of samples per row in the waveform.

If the wfmBufferSize is 0, the number of samples in the waveform is returned in the numSamplesPerRowInWfm parameter and the number of rows in the waveform is returned in the numRowsInWfm parameter.

Return Value

WAS THIS ARTICLE HELPFUL?

Not Helpful