AdsClientReadAnyAsync(UInt32, UInt32, Type, Int32, CancellationToken) Method

Read any as an asynchronous operation.

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

Syntax

C#

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

Parameters

indexGroup UInt32	Index group of the ADS variable.
indexOffset UInt32	Index offset of the ADS variable.
type Type	Type of the object to be read.
args Int32	Additional arguments.
cancel CancellationToken	The cancellation token.

Return Value

Task ResultAnyValue
A Task<ResultAnyValue> representing the asynchronous operation.

Implements

IAdsAnyAccessReadAnyAsync(UInt32, UInt32, Type, 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 ReadAnyAsync Overload TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026