ResultWriteControl Class

Class ResultWriteControl. Implements the ResultAds

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.ResultAds
    TwinCAT.Ads.ResultWriteControl
Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public class ResultWriteControl : ResultAds

The ResultWriteControl type exposes the following members.

Constructors

 

Name

Description

ResultWriteControl(ResultWriteControl)

Initializes a new instance of the ResultWriteControl class.

ResultWriteControl(AmsAddress, Boolean, AdsErrorCode, AdsStateCommand, AdsState, AdsState, TimeSpan)

Initializes a new instance of the ResultWriteControl class.

Properties

 

Name

Description

Empty

Gets the empty ResultWriteControl

ErrorCode

Gets the ADS Error code bound to this Result object. (Inherited from ResultAds.)

Failed

Gets a value indicating whether the ResultAds state is failed. (Inherited from ResultAds.)

InvokeId

Gets the ADS requests invoke identifier (or 0 if not supported) (Inherited from ResultAds.)

Succeeded

Gets a value indicating whether the ResultAds state is succeeded. (Inherited from ResultAds.)

Methods

 

Name

Description

Create

Creates an ResultWriteControl object.

CreateFailed(AmsAddress, AdsErrorCode, AdsStateCommand)

Creates a failed ResultWriteControl object.

CreateFailed(AmsAddress, AdsErrorCode, AdsStateCommand, AdsState)

Creates a failed ResultWriteControl object.

CreateFailed(AmsAddress, AdsErrorCode, AdsStateCommand, AdsState, AdsState)

Creates a failed ResultWriteControl object.

CreateSucceeded

Creates a succeeding ResultWriteControl object.

Equals

Determines whether the specified object is equal to the current object. (Inherited from Object.)

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

GetHashCode

Serves as the default hash function. (Inherited from Object.)

GetType

Gets the Type of the current instance. (Inherited from Object.)

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

SetError

Sets the error state of this ResultAds (Inherited from ResultAds.)

ToString

Returns a string that represents the current object. (Inherited from Object.)

Fields

 

Name

Description

Address

The address

Latency

The latency/duration until the Result state has been reached.

Original

The original state before the request is sent.

Reached

The reached AdsState after the AdsStateCommand request has been sent (Resulting state)

Requested

The AdsStateCommand (Request)

RequestSucceeded

Gets an indication if the WriteControl request has been succeeded.

Reference

TwinCAT.Ads Namespace

TwinCAT.Ads.ResultAds