niHSDIO_ReadMultiRecordU16

NI Digital Waveform Generator/Analyzer

niHSDIO_ReadMultiRecordU16

Specific Function

C Function Prototype

ViStatus niHSDIO_ReadMultiRecordU16 (ViSession vi, ViInt32 samplesToRead, ViInt32 maxTimeMilliseconds, ViInt32 startingRecord, ViInt32 recordsToRead, ViUInt16[] waveformData, niHSDIO_wfmInfo * waveformInfo);

Purpose

This function initiates a multirecord acquisition, and returns the acquired waveform as a two-dimensional array of unsigned 16-bit data.

Parameters

Name Type Description
vi ViSession This handle identifies your instrument session. vi was obtained from niHSDIO_InitAcquisitionSession.
samplesToRead ViInt32 Number of samples to fetch.
maxTimeMilliseconds ViInt32 This attribute specifies in milliseconds how long to allow the function to complete before returning a timeout error.

A value of -1 causes the function to never time out.
startingRecord ViInt32 The first record you want to fetch.
recordsToRead ViInt32 The number of records you want to fetch.
waveformData ViUInt16[] The array of waveform data that contains the records to fetch.
waveformInfo niHSDIO_wfmInfo * Returns information about the records. waveformInfo includes an absolute timestamp, relative timestamp, the number of samples fetched, and the dT of the waveform.

Return Value