ResultHandle Class

Result object for asynchronous registering an ADS Handle via tasks.

Inheritance Hierarchy

SystemObject
  TwinCAT.AdsResultAds
    TwinCAT.AdsResultHandle

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

Syntax

C#

public class ResultHandle : ResultAds

The ResultHandle type exposes the following members.

Properties

 

Name

Description

ResultHandle Class 1:

ResultHandle Class 2:

Empty

Gets the empty ResultHandle object.

ResultHandle Class 3:

ErrorCode

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

ResultHandle Class 4:

Failed

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

ResultHandle Class 5:

Handle

Gets the registered handle

ResultHandle Class 6:

InvokeId

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

ResultHandle Class 7:

Succeeded

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

ResultHandle Class 8:

TimeStamp

Gets the time stamp of the result.
(Inherited from ResultAds)

Methods

 

Name

Description

ResultHandle Class 9:

CreateError(AdsErrorCode)

Creates an Error Result.

ResultHandle Class 10:

CreateError(AdsErrorCode, UInt32)

Creates an Error Result.

ResultHandle Class 11:

CreateSuccess(UInt32)

Creates a success result.

ResultHandle Class 12:

CreateSuccess(UInt32, UInt32)

Creates a success result.

ResultHandle Class 13:

Equals

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

ResultHandle Class 14:

Finalize

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

ResultHandle Class 15:

GetHashCode

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

ResultHandle Class 16:

GetType

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

ResultHandle Class 17:

MemberwiseClone

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

ResultHandle Class 18:

SetError

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

ResultHandle Class 19:

ToString

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

Operators

 

Name

Description

(ResultHandle to ResultHandleAccess)

Performs an implicit conversion from ResultHandle to ResultHandleAccess.

Fields

 

Name

Description

timeStamp

The timestamp
(Inherited from ResultAds)

Reference

TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026