NI-DAQmx .NET Framework 4.0 API Reference

Content Type
Programming Language
Current manual
Table of Contents
Product DocumentationNI-DAQmx .NET Framework 4.0 API ReferenceCounterMultiChannelReader.EndMemoryOptimizedReadMultiSampleInt32 MethodCurrent page
Table of Contents

CounterMultiChannelReader.EndMemoryOptimizedReadMultiSampleInt32 Method

CounterMultiChannelReader.EndMemoryOptimizedReadMultiSampleInt32 Method

CounterMultiChannelReaderEndMemoryOptimizedReadMultiSampleInt32 Method

Handles the end of an asynchronous read initiated with BeginMemoryOptimizedReadMultiSampleInt32(Int32, AsyncCallback, Object, Int32) and retrieves the read samples.

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

Syntax

public int[,] EndMemoryOptimizedReadMultiSampleInt32(
	IAsyncResult asyncResult,
	out int actualNumberOfSamplesPerChannelRead
)
Public Function EndMemoryOptimizedReadMultiSampleInt32 ( 
	asyncResult As IAsyncResult,
	<OutAttribute> ByRef actualNumberOfSamplesPerChannelRead As Integer
) As Integer(,)

Parameters

asyncResult
Type: SystemIAsyncResult
An IAsyncResult that represents an asynchronous call started by calling BeginMemoryOptimizedReadMultiSampleInt32(Int32, AsyncCallback, Object, Int32).
actualNumberOfSamplesPerChannelRead
Type: SystemInt32
The actual number of samples per channel read. This is useful when the reading operation yields fewer samples than the actual length of data.

Return Value

Type: Int32
A 2D array of Int32 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.

Exceptions

ExceptionCondition
ArgumentException
  1. If data is or is uninitialized;
  2. If the first dimension of data does not match the number of channels;
  3. If ReallocationPolicy is not ToGrow, and data is not capable of holding the required number of samples; or
  4. For asynchronous reads, if asyncResult is or is not an instance of IAsyncResult returned from a call to BeginMemoryOptimizedReadMultiSampleInt32(Int32, AsyncCallback, Object, Int32).
DaqExceptionThe NI-DAQmx driver returned an error during the asynchronous operation.
OutOfMemoryExceptionThere is not enough memory to carry out this operation.

Remarks

If you call this method before the asynchronous read IAsyncResult is complete, it waits for the read to complete before returning.

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.

Note Note
Refer to Asynchronous Reads and Writes for additional information.

See Also

Was this information helpful?