ResultAds Class

Base class for an (asynchronous) ADS Task Result

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.ResultAds
    More...

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

Syntax

C#

public class ResultAds

The ResultAds type exposes the following members.

Constructors

 

Name

Description

ResultAds(AdsErrorCode)

Initializes a new instance of the ResultAds class.

ResultAds(AdsErrorCode, UInt32)

Initializes a new instance of the ResultAds class.

Properties

 

Name

Description

ResultAds Class 1:

ResultAds Class 2:

Empty

Gets an empty ResultAds initialized to None.

ResultAds Class 3:

ErrorCode

Gets the ADS Error code bound to this Result object.

ResultAds Class 4:

Failed

Gets a value indicating whether the ResultAds state is failed.

ResultAds Class 5:

InvokeId

Gets the ADS requests invoke identifier (or 0 if not supported)

ResultAds Class 6:

Succeeded

Gets a value indicating whether the ResultAds state is succeeded.

Methods

 

Name

Description

ResultAds Class 7:

ResultAds Class 8:

CreateError(AdsErrorCode)

Creates an Error Result.

ResultAds Class 9:

ResultAds Class 10:

CreateError(AdsErrorCode, UInt32)

Creates an Error Result.

ResultAds Class 11:

ResultAds Class 12:

CreateSuccess.

Creates a success result.

ResultAds Class 13:

ResultAds Class 14:

CreateSuccess(UInt32)

Creates a success result.

ResultAds Class 15:

ResultAds Class 16:

CreateSuccess.TValue.(TValue)

Creates a success result.

ResultAds Class 17:

ResultAds Class 18:

CreateSuccess.TValue.(TValue, UInt32)

Creates a success result.

ResultAds Class 19:

Equals

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

ResultAds Class 20:

Finalize

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

ResultAds Class 21:

GetHashCode

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

ResultAds Class 22:

GetType

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

ResultAds Class 23:

MemberwiseClone

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

ResultAds Class 24:

SetError

Sets the error state of this ResultAds

ResultAds Class 25:

ToString

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

Operators

 

Name

Description

.(ResultAds to ResultAccess)

Performs an implicit conversion from ResultAds to ResultAccess.

Remarks

The base class is used whenever an asynchronous task communicates via ADS and should return its AdsErrorCode within its tasks result.

Reference

TwinCAT.Ads Namespace

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.ResultAds
    TwinCAT.Ads.ResultDeviceInfo
    TwinCAT.Ads.ResultHandle
    TwinCAT.Ads.ResultRead
    TwinCAT.Ads.ResultReadAdsState
    TwinCAT.Ads.ResultReadDeviceState
    TwinCAT.Ads.ResultRpcMethod
    TwinCAT.Ads.ResultValue.TValue.
    TwinCAT.Ads.ResultWrite
    TwinCAT.Ads.ResultWriteControl
    TwinCAT.Ads.SumCommand.ResultSumCommand