AdsConnectionReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken) Method

Reads a string asynchronously from the specified symbol/variable


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

Syntax

C#

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

Parameters

variableHandle  UInt32

The variable handle.

len  Int32

The length.

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 string (Value) and the ErrorCode after execution.

Implements

IAdsAnyAccessReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)

Exceptions

Exception

Condition

ObjectDisposedException

ClientNotConnectedException

Reference

AdsConnection Class ReadAnyStringAsync Overload TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026