NI-DAQmx .NET Framework 4.5 API Reference

AnalogSingleChannelReader.ReadWaveform Method (Int32)

Download PDF

Updated2023-02-21
2 minute(s) read

Reads one or more analog waveform samples from a single AIChannel in a task.

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

Syntax

public virtual AnalogWaveform<double> ReadWaveform(
	int numberOfSamples
)

Public Overridable Function ReadWaveform ( 
	numberOfSamples As Integer
) As AnalogWaveform(Of Double)

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: AnalogWaveformDouble
An AnalogWaveformTData containing samples from the task.

Exceptions

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

Remarks

NI-DAQmx scales the returned data to the units of the measurement, including any custom scaling you apply to the channel. You specify these units with the create channel methods or the DAQ Assistant.

The data returned from analog 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

AnalogSingleChannelReader.ReadWaveform Method (Int32)

Syntax

Parameters

Return Value

Exceptions

Remarks

See Also

Reference

Log in to get a better experience