NI-DAQmx .NET Framework 4.0 API Reference

AnalogMultiChannelReader.ReadWaveform Method (Int32)

  • Updated2023-02-21
  • 2 minute(s) read
AnalogMultiChannelReader.ReadWaveform Method (Int32)
Reads one or more analog waveform samples from one or more AIChannel objects in a task.

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

Syntax

public AnalogWaveform<double>[] ReadWaveform(
	int samplesPerChannel
)
Public Function ReadWaveform ( 
	samplesPerChannel As Integer
) As AnalogWaveform(Of Double)()

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: AnalogWaveformDouble
A 1D array of AnalogWaveformTData 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

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

See Also

Log in to get a better experience