IAdsAnyAccess.WriteAnyAsync Method (UInt32, UInt32, Object, .Int32., CancellationToken)

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.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

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

Parameters

indexGroup

Type: System.UInt32
Contains the index group number of the requested ADS service.

indexOffset

Type: System.UInt32
Contains the index offset number of the requested ADS service.

value

Type: System.Object
Object to write to the ADS device.

args

Type: .System.Int32.
Additional arguments.

cancel

Type: System.Threading.CancellationToken
The cancellation token.

Return Value

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

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

IAdsAnyAccess Interface

WriteAnyAsync Overload

TwinCAT.Ads Namespace