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
	Empty	Gets an empty ResultAds initialized to None.
	ErrorCode	Gets the ADS Error code bound to this Result object.
	Failed	Gets a value indicating whether the ResultAds state is failed.
	InvokeId	Gets the ADS requests invoke identifier (or 0 if not supported)
	Succeeded	Gets a value indicating whether the ResultAds state is succeeded.
	TimeStamp	Gets the time stamp of the result.

Methods

	Name	Description
	CreateError(AdsErrorCode)	Creates an Error Result.
	CreateError(AdsErrorCode, UInt32)	Creates an Error Result.
	CreateSuccess	Creates a success result.
	CreateSuccess(UInt32)	Creates a success result.
	CreateSuccessTValue(TValue)	Creates a success result.
	CreateSuccessTValue(TValue, UInt32)	Creates a success result.
	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
	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.

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

Beckhoff Automation GmbH & Co. KG 2001-2026

Further Information