AdsServer.OnWriteControlAsync Method

Called when an ADS Write Control indication is received.

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

Syntax

C#

protected virtual Task<ResultAds> OnWriteControlAsync(
    AmsAddress sender,
    uint invokeId,
    AdsState adsState,
    ushort deviceState,
    ReadOnlyMemory<byte> data,
    CancellationToken cancel
)

Parameters

sender	Type: TwinCAT.Ads.AmsAddress The sender address of the request.
invokeId	Type: System.UInt32 The invoke identifier of the request.
adsState	Type: TwinCAT.Ads.AdsState The requested new ADS state of this ADS device
deviceState	Type: System.UInt16 The requested new device state of this ADS device
data	Type: System.ReadOnlyMemory.Byte. Additional data to write.
cancel	Type: System.Threading.CancellationToken The cancellation token.

Return Value

Type: Task.ResultAds.
A task that represents the asynchronous WriteControlIndicationAsync(AmsAddress, UInt32, AdsState, UInt16, ReadOnlyMemory.Byte., CancellationToken) operation. The Task.TResult. parameter contains the AdsErrorCode as Result.

Remarks

Overwrite this method in derived classes to react on ADS Write Control indications. The default implementation replies with an ADS ServiceNotSupported error code (0x701).

Reference

AdsServer Class

TwinCAT.Ads.Server Namespace