NI-DAQmx .NET Framework 4.5 API Reference

Content Type
Programming Language
Current manual
Table of Contents
Product DocumentationNI-DAQmx .NET Framework 4.5 API Reference...BeginMemoryOptimizedReadMultiSampleUInt32 Method CounterMultiChannelReader.BeginMemoryOptimizedReadMultiSampleUInt32 Method (Int32, AsyncCallback, Object, UInt32[,])Current page
Table of Contents

CounterMultiChannelReader.BeginMemoryOptimizedReadMultiSampleUInt32 Method (Int32, AsyncCallback, Object, UInt32[,])

CounterMultiChannelReader.BeginMemoryOptimizedReadMultiSampleUInt32 Method (Int32, AsyncCallback, Object, UInt32[,])

CounterMultiChannelReaderBeginMemoryOptimizedReadMultiSampleUInt32 Method (Int32, AsyncCallback, Object, UInt32)

Begins an asynchronous read of one or more UInt32 samples from one or more CIChannel objects in a task.

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

Syntax

public IAsyncResult BeginMemoryOptimizedReadMultiSampleUInt32(
	int samplesPerChannel,
	AsyncCallback callback,
	Object state,
	uint[,] data
)
Public Function BeginMemoryOptimizedReadMultiSampleUInt32 ( 
	samplesPerChannel As Integer,
	callback As AsyncCallback,
	state As Object,
	data As UInteger(,)
) As IAsyncResult

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.
callback
Type: SystemAsyncCallback
An optional asynchronous callback that is called when the read is complete. Specify if you do not want a callback when the read is complete.
state
Type: SystemObject
A user-provided object that distinguishes this asynchronous read request from other requests. Use this parameter to provide information to the callback. Specify if you do not need to pass any additional information to the callback.
data
Type: SystemUInt32
An initialized 2D array of UInt32 samples that contains the read data. Each element in the first dimension of the array corresponds to a channel in the task. Each element in the second dimension of the array corresponds to a sample from each of the channels. 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.

Return Value

Type: IAsyncResult
An IAsyncResult that represents the asynchronous call.

Remarks

If the data buffer is large enough to hold the number of samples requested, this overload attempts to reuse existing memory allocated from the array to acquire data. This results in more efficient memory allocation when performing multiple reads with a continuous analog input task.

To get the read data or any exceptions that occurred during an asynchronous read initiated with this method, call EndMemoryOptimizedReadMultiSampleUInt32(IAsyncResult, Int32) with the returned IAsyncResult.

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.

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

In This Section
Was this information helpful?