niHSDIO_HWC_FetchSampleErrors

NI Digital Waveform Generator/Analyzer

niHSDIO_HWC_FetchSampleErrors

Specific Function

C Function Prototype

ViStatus niHSDIO_HWC_FetchSampleErrors (ViSession vi, ViInt32* numSampleErrorsToRead, ViInt32 maxTimeMilliseconds, ViReal64[] sampleNumber, ViUInt32[] errorBits, ViInt32[] errorRepeatCount, ViUInt32* reserved1, ViUInt32* reserved2);

Purpose

Returns the sample error information from a hardware comparison operation.

Parameters

Name Type Description
vi ViSession This handle identifies your instrument session. vi was obtained from niHSDIO_InitAcquisitionSession.
numSampleErrorsToRead ViInt32* Specifies the number of sample errors to fetch.
maxTimeMilliseconds ViInt32 Specifies in milliseconds how long to allow the function to complete before returning a timeout error.

A value of 0 causes the function to return immediately with up to the number of samples specified in samplesToRead. If you set maxTimeMilliseconds to a value other than 0, and timeout occurs before all the samples are acquired, you receive a timeout error. If you specify a value for samplesToRead that is greater than the number of samples in the device memory, NI-HSDIO returns the available samples after max time milliseconds. A value of –1 causes the function to never timeout.
sampleNumber ViReal64[] Returns the number of samples with errors.
errorBits ViUInt32[] Returns the bit numbers that were in error for each sample that has an error.
errorRepeatCount ViInt32[] Returns the number of times that error was repeated.
reserved1 ViUInt32* Reserved.
reserved2 ViUInt32* Reserved.

Return Value