NI-DAQmx .NET Framework 4.5 API Reference

Table of Contents

AnalogSingleChannelReader.ReadWaveform Method (TimeSpan)

  • Updated2023-02-21
  • 1 minute(s) read
AnalogSingleChannelReader.ReadWaveform Method (TimeSpan)
Reads one or more analog waveform samples from a single AIChannel object in a task for a specified duration.

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

Syntax

public virtual AnalogWaveform<double> ReadWaveform(
	TimeSpan duration
)
Public Overridable Function ReadWaveform ( 
	duration As TimeSpan
) As AnalogWaveform(Of Double)

Parameters

duration
Type: SystemTimeSpan
The duration of time to read the waveform. The duration specified must be long enough to read at least one sample at the configured SampleClockRate.

Return Value

Type: AnalogWaveformDouble
An AnalogWaveformTData containing samples from the task.

Exceptions

ExceptionCondition
ArgumentException If the duration provided was less than Zero.
DaqExceptionThe NI-DAQmx driver returned an error.

Remarks

NI-DAQmx scales the read data to the units of the measurement, including any custom scaling you apply to the channel. You specify these units when creating channels using the create channel methods or the DAQ Assistant.

The data returned from analog waveform reads is affected by the WaveformAttributeMode property of the DaqStream being read.

NI-DAQmx read and write methods time out after the amount of time specified by the Timeout property on the Stream object used for the reads or writes.

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