NI-DAQmx .NET Framework 4.5 API Reference

DigitalMultiChannelReader.ReadWaveform Method (Int32)

Download PDF

Updated2023-02-21
2 minute(s) read

Reads one or more digital waveform samples from one or more DIChannel objects in a task.

Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.45.49302

Syntax

public DigitalWaveform[] ReadWaveform(
	int samplesPerChannel
)

Public Function ReadWaveform ( 
	samplesPerChannel As Integer
) As DigitalWaveform()

Parameters

samplesPerChannel: Type: SystemInt32
The number of samples to read. If you set samplesPerChannel to -1 for a continuous acquisition, the read retrieves all samples available in the buffer at the time of the read. If you set samplesPerChannel to -1 for a finite acquisition, the read behavior is set by the ReadAllAvailableSamples property of the DaqStream you are reading from.

Return Value

Type: DigitalWaveform
A 1D array of DigitalWaveform objects containing samples from the task. Each element in the array corresponds to a channel in the task. The order of the channels in the array corresponds to the order in which you add the channels to the task or to the order of the channels you specify in ChannelsToRead.

Exceptions

Exception	Condition
DaqException	The NI-DAQmx driver returned an error.
OutOfMemoryException	There is not enough memory to carry out this operation.

Remarks

The data returned from digital waveform reads is affected by the WaveformAttributeMode property of the DaqStream you are reading from.

NI-DAQmx read and write methods time out after the amount of time specified by the Timeout property on the task you are reading from or writing to.

Refer to NI-DAQmx Readers and Writers for more information about memory limitations in NI-DAQmx read methods.

NI-DAQmx .NET Framework 4.5 API Reference

Table of Contents

DigitalMultiChannelReader.ReadWaveform Method (Int32)

Syntax

Parameters

Return Value

Exceptions

Remarks

See Also

Reference

Log in to get a better experience