NI-DAQmx .NET Framework 4.0 API Reference

DigitalSingleChannelWriter.BeginWriteSingleSamplePort Method (Boolean, UInt16, AsyncCallback, Object)

Download PDF

Updated2023-02-21
2 minute(s) read

Begins an asynchronous write of a single 16-bit unsigned integer sample to a single DOChannel in a task.

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

Syntax

public IAsyncResult BeginWriteSingleSamplePort(
	bool autoStart,
	ushort data,
	AsyncCallback callback,
	Object state
)

Public Function BeginWriteSingleSamplePort ( 
	autoStart As Boolean,
	data As UShort,
	callback As AsyncCallback,
	state As Object
) As IAsyncResult

Parameters

autoStart: Type: SystemBoolean
If set to this method automatically calls Start if you do not explicitly call it. You cannot set this parameter to if you have installed events on the task.
data: Type: SystemUInt16
A sample to write to the task.
callback: Type: SystemAsyncCallback
An optional asynchronous callback that is called when the write is complete. Specify if you do not want a callback when the write is complete.
state: Type: SystemObject
A user-provided object that distinguishes this asynchronous write 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.

Return Value

Type: IAsyncResult
An IAsyncResult that represents the asynchronous call.

Remarks

Pass the returned IAsyncResult to EndWrite(IAsyncResult) to get any exceptions that occurred during the asynchronous write or to wait for the write to complete.

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.

This method returns immediately if the output buffer has sufficient space for the samples. Otherwise, the call is blocked until the application generates enough samples to fit the new data into the output buffer.

Note
Refer to Asynchronous Reads and Writes for additional information.

NI-DAQmx .NET Framework 4.0 API Reference

Table of Contents

DigitalSingleChannelWriter.BeginWriteSingleSamplePort Method (Boolean, UInt16, AsyncCallback, Object)

Syntax

Parameters

Return Value

Remarks

See Also

Reference

Other Resources

Log in to get a better experience