IAdsAnyAccessReadAnyAsync(UInt32, Type, Int32, CancellationToken) Method

Reads data synchronously from an ADS device and writes it to an object.


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

Syntax

C#

Task<ResultAnyValue> ReadAnyAsync(
    uint variableHandle,
    Type type,
    int[]? args,
    CancellationToken cancel
)

Parameters

variableHandle  UInt32

The variable handle.

type  Type

Type of the object to be read.

args  Int32

Additional arguments.

cancel  CancellationToken

The cancellation token.

Return Value

Task ResultAnyValue
A task that represents the asynchronous read operation. The ResultAnyValue parameter contains the read value (Value) and the ErrorCode after execution.

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 ReadAnyAsync Overload TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026