AdsConnection.ReadAnyAsync Method (UInt32, UInt32, Type, .Int32., CancellationToken)

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

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

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

Parameters

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

Return Value

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

Implements

IAdsAnyAccess.ReadAnyAsync(UInt32, UInt32, Type, .Int32., CancellationToken)

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

AdsConnection Class

ReadAnyAsync Overload

TwinCAT.Ads Namespace