NI-DAQmx .NET Framework 4.0 API Reference

DigitalSingleChannelReader.ReadWaveform Method (Int32)

  • Updated2023-02-21
  • 1 minute(s) read
DigitalSingleChannelReader.ReadWaveform Method (Int32)
Reads one or more digital waveform samples from a single DIChannel in a task.

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

Syntax

public DigitalWaveform ReadWaveform(
	int numberOfSamples
)
Public Function ReadWaveform ( 
	numberOfSamples As Integer
) As DigitalWaveform

Parameters

numberOfSamples
Type: SystemInt32
The number of samples to read. If you set numberOfSamples to -1 for a continuous acquisition, the read retrieves all samples available in the buffer at the time of the read. If you set numberOfSamples 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 DigitalWaveform containing samples from the task.

Exceptions

ExceptionCondition
DaqExceptionThe NI-DAQmx driver returned an error.
OutOfMemoryExceptionThere 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.

See Also

Log in to get a better experience