AdsConnectionReadAnyStringAsync(UInt32, UInt32, Int32, Encoding, CancellationToken) Method

read any string as an asynchronous operation.


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

Syntax

C#

public Task<ResultAnyValue> ReadAnyStringAsync(
    uint indexGroup,
    uint indexOffset,
    int len,
    Encoding? encoding,
    CancellationToken cancel
)

Parameters

indexGroup  UInt32

The index group.

indexOffset  UInt32

The index offset.

len  Int32

The string length to be read.

encoding  Encoding

The string value encoding (IAdsConnection.DefaultValueEncoding if null)

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.

Implements

IAdsAnyAccessReadAnyStringAsync(UInt32, UInt32, Int32, Encoding, CancellationToken)

Exceptions

Exception

Condition

ObjectDisposedException

ClientNotConnectedException

Reference

AdsConnection Class ReadAnyStringAsync Overload TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026