ResultAds Class

Base class for an (asynchronous) ADS Task Result

Inheritance Hierarchy

SystemObject
  TwinCAT.AdsResultAds
    TwinCAT.AdsResultDeviceInfo
    TwinCAT.AdsResultHandle
    TwinCAT.AdsResultNotificationHandle
    TwinCAT.AdsResultRead
    TwinCAT.AdsResultReadAdsState
    TwinCAT.AdsResultReadDeviceState
    TwinCAT.AdsResultRpcMethod
    TwinCAT.AdsResultValueTValue
    TwinCAT.AdsResultWrite
    TwinCAT.Ads.SumCommandResultSumCommand

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

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.

ResultAds Class 7:

TimeStamp

Gets the time stamp of the result.

Methods

 

Name

Description

ResultAds Class 8:

ResultAds Class 9:

CreateError(AdsErrorCode)

Creates an Error Result.

ResultAds Class 10:

ResultAds Class 11:

CreateError(AdsErrorCode, UInt32)

Creates an Error Result.

ResultAds Class 12:

ResultAds Class 13:

CreateSuccess

Creates a success result.

ResultAds Class 14:

ResultAds Class 15:

CreateSuccess(UInt32)

Creates a success result.

ResultAds Class 16:

ResultAds Class 17:

CreateSuccessTValue(TValue)

Creates a success result.

ResultAds Class 18:

ResultAds Class 19:

CreateSuccessTValue(TValue, UInt32)

Creates a success result.

ResultAds Class 20:

Equals

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

ResultAds Class 21:

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 22:

GetHashCode

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

ResultAds Class 23:

GetType

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

ResultAds Class 24:

MemberwiseClone

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

ResultAds Class 25:

SetError

Sets the error state of this ResultAds

ResultAds Class 26:

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.

Fields

 

Name

Description

 

timeStamp

The timestamp

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

Beckhoff Automation GmbH & Co. KG 2001-2026