AdsClientWriteAnyAsync(UInt32, Object, Int32, CancellationToken) Method

Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public Task<ResultWrite> WriteAnyAsync(
    uint variableHandle,
    Object value,
    int[]? args,
    CancellationToken cancel
)

Parameters

variableHandle UInt32	Handle of the ADS variable.
value Object	Object to write to the ADS device.
args Int32	Additional arguments.
cancel CancellationToken	The cancellation token.

Return Value

Task ResultWrite
A task that represents the asynchronous task operation. The result parameter ResultWrite of the write operation contains the ErrorCode.

Implements

IAdsAnyAccessWriteAnyAsync(UInt32, Object, Int32, CancellationToken)

Exceptions

Exception	Condition
ObjectDisposedException
ClientNotConnectedException

Remarks

As object types only primitive types are supported. If the Type of the object to be read is a string type, the first element of the parameter args specifies the number of characters of the string. If the Type of the object to be read is an array type, the number of elements for each dimension has to be specified in the parameter args.

Type of value Parameter	Necessary Arguments (args)
string	args[0]: Number of characters in the string typed as FixedLengthZeroTerminated.
string[]
Array

Reference

AdsClient Class WriteAnyAsync Overload TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026