TwinCAT.Ads Namespace

Classes

	Class	Description
	AdsClient	ADS Client / ADS Communication object.
	AdsClientExtensions	Class AdsClientExtensions.
	AdsClientSettings	Settings object for the AdsClient class.
	AdsConnection	ADS Connection class
	AdsDataTypeArrayInfo	Array definition for a single dimension.
	AdsErrorCodeExtension	Class AdsErrorCodeExtensions.
	AdsErrorException	The exception that is thrown when an ADS error occurs.
	AdsInvalidNotificationException	This AdsInvalidNotificationException is created if the length of the notification data is 0. This indicates that the notification handle is not valid any more. This exception is passed to the AdsNotificationErrorEvent.
	AdsNotificationErrorEventArgs	Arguments for the AdsNotificationError events.
	AdsNotificationEventArgs	Event argument class for AdsNotification events.
	AdsNotificationExEventArgs	Arguments for AdsNotificationEx events.
	AdsNotificationsInvalidatedEventArgs	Class AdsNotificationsUnregisteredEventArgs. This class cannot be inherited. Implements the EventArgs
	AdsSession	AdsSession class
	AdsSessionBase	Abstract base class for ADS Sessions.
	AdsStateChangedEventArgs	Arguments for the AdsStateChanged event.
	AdsStateChangedEventArgs2	Event Arguments for AdsStateChanged events.
	AdsSumCommandException	The exception that is thrown when an ADS SumCommandBase error occurs.
	AdsSymbolVersionChangedEventArgs	Arguments for the AdsSymbolVersionChanged event.
	AdsVersion	The structure contains the version number, revision number and build number.
	AmsAddress	Ams/Ads Address
	AmsNetId	Class representing an Address in the TwinCAT System (AMS/ADS Net ID).
	AmsRouterNotificationEventArgs	Arguments for the IRouterNotificationProvider events.
	DeviceInfo	The structure contains the name and the version information of the device.
	GlobalConfiguration	Global configuration object
	Notification	Class Notification. Implements the INotification
	NotificationSettings	Notification communication settings
	ResultAds	Base class for an (asynchronous) ADS Task Result
	ResultAnyValue	Result object for asynchronous reading an 'AnyValue'/Primitive Value via tasks.
	ResultDefault	Class ResultDefault.
	ResultDeviceInfo	Ads Task Result for DeviceInfo requests (async operations).
	ResultHandle	Result object for asynchronous registering an ADS Handle via tasks.
	ResultNotificationHandle	Result object for asynchronous registering an ADS Handle via tasks.
	ResultRead	Asynchronous ADS Read result.
	ResultReadAdsState	Result object for asynchronous reading AdsStates via tasks.
	ResultReadBytes	ADS Task Result returning Read data for async Read operations.
	ResultReadDeviceState	Result object for asynchronous ADS ReadDeviceState tasks.
	ResultReadWrite	Result object for asynchronous ADS ReadWrite tasks.
	ResultReadWriteBytes	Result object for asynchronous ADS ReadWrite tasks.
	ResultRpcMethod	Class representing a result of an asynchronous RpcMethod call. Implements the ResultAds
	ResultValueTValue	ADS Result object returning a generic value result (TValue) (asynchronous read). Implements the ResultAds
	ResultValue2I, V	Result object of an asynchronous read. Implements the ResultAccess
	ResultWrite	Result for asynchronous ADS write tasks.
	ResultWriteControl	Class ResultWriteControl. Implements the ResultAds
	SessionSettings	Session settings class
	TaskExtensions	TaskExtensions for Task Cancellation and Timeout
	ValueNotificationEventArgsT	Arguments for AdsNotificationEx events.

Structures

	Structure	Description
	StateInfo	The structure contains the ADS state and device state.

Interfaces

	Interface	Description
	IAdsAnyAccess	Interface for accessing ADS 'Any' objects.
	IAdsConnectAddress	Interface for method to connect the ADS client via AMS Address.
	IAdsConnection	ADS Connection interface
	IAdsDisposableConnection	Interface IAdsDisposableConnection Implements the IAdsConnectAddress Implements the IRouterNotificationProvider Implements the IAdsSymbolChangedProvider Implements the IDisposable
	IAdsHandle	Interface for ADS access via variable handle
	IAdsNotifications	Interface for Notification management.
	IAdsReadWrite	Interface for ADS Read/Write access via IndexGroup / IndexOffset
	IAdsReadWriteTimeoutAccess	Interface IAdsReadWriteTimeoutAccess
	IAdsRpcInvoke	Interface IAdsRpcInvoke
	IAdsSession	Interface IAdsSession
	IAdsSessionSettings	Interface for ADS Session Settings
	IAdsStateControl	Interface for reading and controlling the ADS state.
	IAdsStateControlTimeout	Interface IAdsStateControlTimeout
	IAdsStateObserver	Interface for an AdsState observer
	IAdsStateProvider	Interface IAdsStateProvider
	IAdsSymbolChangedProvider	Interface IAdsSymbolChangedProvider
	IAdsSymbolicAccess	Interface for symbolic ADS access (Read or Write)
	INotification	Common INotification interface
	INotificationSettings	Interface for Notification Settings Implements the IComparableT
	IRouterNotificationProvider	Interface for AMS Router Notifications.
	ITcAdsRaw	Internal Raw ADS interface
	ITcAdsRawAny	Interface defining ADS read/writes addressed by IndexGroup/IndexOffset or handle.

Enumerations

	Enumeration	Description
	AdsCommandId	AdsCommandId Enumeration (for AdsCommand typed commands.
	AdsDataTypeId	ADS data types.
	AdsErrorCode	ADS request return codes.
	AdsState	Describes the AdsState.
	AdsStateCommand	Describes the AdsState Commands
	AdsTransMode	ADS Transmission Mode for ADS Notifications.
	AmsPort	Ams Ports Definitions.
	AmsPortRange	Defines ranges of AmsPorts.
	AmsRouterState	State of the AMS Router.
	ChannelPortType	Enum ChannelPortType
	ChannelProtocol	Enum ChannelProtocol (Ads, AdsOverMqtt, All
	IndexGroupSymbolAccess	ADS IndexGroups defined for ADS Symbol Handling
	TransportProtocols	Enum ADS TransportProtocol

Beckhoff Automation GmbH & Co. KG 2001-2026