IAdsConnection Interface

ADS Connection interface


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

Syntax

C#

public interface IAdsConnection : IConnection, 
    IConnectionStateProvider, IAdsNotifications, IAdsSymbolicAccess, IAdsAnyAccess, IAdsHandle, 
    IAdsReadWrite, IAdsStateProvider, IAdsStateControl, IAdsSymbolChangedProvider, IAdsRpcInvoke

The IAdsConnection type exposes the following members.

Properties

 

Name

Description

IAdsConnection Interface 1:

Address

Gets the AmsAddress of the ADS server.

IAdsConnection Interface 2:

ChannelPortType

Gets the channel port type.

IAdsConnection Interface 3:

ChannelProtocol

Gets the channel protocol.

IAdsConnection Interface 4:

ClientAddress

Get the AmsAddress of the ADS client.

IAdsConnection Interface 5:

Configuration

Gets the configuration.
(Inherited from IConnection)

IAdsConnection Interface 6:

IAdsConnection Interface 7:

ConnectionState

Gets the current Connection state of the IConnectionStateProvider
(Inherited from IConnectionStateProvider)

IAdsConnection Interface 8:

DefaultValueEncoding

Gets/Sets the default value encoding.
(Inherited from IConnection)

IAdsConnection Interface 9:

Id

Gets the Connection Identifier .
(Inherited from IConnection)

IAdsConnection Interface 10:

IsConnected

Gets a value indicating whether the local ADS port was opened successfully. It does not indicate if the target port is available. Use the method ReadState to determine if the target port is available.
(Inherited from IConnection)

IAdsConnection Interface 11:

IsLocal

Gets a value indicating whether the ADS client is connected to a ADS Server on the local computer.

IAdsConnection Interface 12:

Logger

Gets the connection logger interface.
(Inherited from IConnection)

IAdsConnection Interface 13:

LoggerFactory

Gets the logger factory.
(Inherited from IConnection)

IAdsConnection Interface 14:

Session

Gets the session that initiated this IConnection
(Inherited from IConnection)

IAdsConnection Interface 15:

SymbolEncoding

Gets/Sets the symbol encoding.
(Inherited from IConnection)

IAdsConnection Interface 16:

Timeout

Gets the timeout (in milliseconds)
(Inherited from IConnection)

Methods

 

Name

Description

IAdsConnection Interface 17:

AddDeviceNotification(String, Int32, NotificationSettings, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 18:

AddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 19:

AddDeviceNotificationAsync(String, Int32, NotificationSettings, Object, CancellationToken)

Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 20:

AddDeviceNotificationAsync(UInt32, UInt32, Int32, NotificationSettings, Object, CancellationToken)

Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 21:

AddDeviceNotificationEx(String, NotificationSettings, Object, Type)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 22:

AddDeviceNotificationEx(String, NotificationSettings, Object, Type, Int32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 23:

AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 24:

AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. If type is a string type, the first element of the parameter args specifies the number of characters of the string. If type is an array type, the number of elements for each dimension has to be specified in the parameter args. Only primitive ('AnyType') types are allowed for the parameter type.
(Inherited from IAdsNotifications)

IAdsConnection Interface 25:

AddDeviceNotificationExAsync(String, NotificationSettings, Object, Type, Int32, CancellationToken)

Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 26:

AddDeviceNotificationExAsync(UInt32, UInt32, NotificationSettings, Object, Type, Int32, CancellationToken)

Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 27:

CleanupSymbolTable

Clears the internal symbol / DataTypes cache.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 28:

Close

Closes this IConnection
(Inherited from IConnection)

IAdsConnection Interface 29:

Connect

(Re)Connects the IConnection when disconnected.
(Inherited from IConnection)

IAdsConnection Interface 30:

ConnectAndWaitAsync

Connects the and wait asynchronous.
(Inherited from IConnection)

IAdsConnection Interface 31:

ConnectAsync

Connects the IConnection asynchronously when disconnected.
(Inherited from IConnection)

IAdsConnection Interface 32:

CreateVariableHandle

Determines the Symbol handle by its instance path synchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 33:

CreateVariableHandleAsync

Determines the Symbol handle by its instance path asynchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 34:

DeleteDeviceNotification

Deletes a registered notification.
(Inherited from IAdsNotifications)

IAdsConnection Interface 35:

DeleteDeviceNotificationAsync

Deletes a registered notification asynchronously.
(Inherited from IAdsNotifications)

IAdsConnection Interface 36:

DeleteVariableHandle

Releases the specified symbol/variable handle synchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 37:

DeleteVariableHandleAsync

Releases the specified symbol/variable handle asynchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 38:

Disconnect

Disconnects this IConnection.
(Inherited from IConnection)

IAdsConnection Interface 39:

DisconnectAsync

Disconnects the IConnection when connected (asynchronously)
(Inherited from IConnection)

IAdsConnection Interface 40:

IAdsConnection Interface 41:

InvokeRpcMethodAsync(String, String, Object, CancellationToken)

Invokes the specified RPC Method asynchronously
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 42:

IAdsConnection Interface 43:

InvokeRpcMethodAsync(IRpcCallableInstance, IRpcMethod, Object, AnyTypeSpecifier, AnyTypeSpecifier, CancellationToken)

Invokes the specified RPC Method asynchronously
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 44:

IAdsConnection Interface 45:

InvokeRpcMethodAsync(String, String, Object, AnyTypeSpecifier, AnyTypeSpecifier, CancellationToken)

Invokes the specified RPC Method asynchronously
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 46:

Read

Reads data synchronously from an ADS device and writes to the specified readBuffer.
(Inherited from IAdsHandle)

IAdsConnection Interface 47:

ReadAny(String, Type)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 48:

ReadAny(UInt32, Type)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 49:

ReadAny(String, Type, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 50:

ReadAny(UInt32, Type, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 51:

ReadAny(UInt32, UInt32, Type)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 52:

ReadAny(UInt32, UInt32, Type, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 53:

ReadAnyT(String)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 54:

ReadAnyT(UInt32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 55:

ReadAnyT(String, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 56:

ReadAnyT(UInt32, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 57:

ReadAnyT(UInt32, UInt32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 58:

ReadAnyT(UInt32, UInt32, Int32)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 59:

ReadAnyAsync(String, Type, CancellationToken)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 60:

ReadAnyAsync(UInt32, Type, CancellationToken)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 61:

ReadAnyAsync(String, Type, Int32, CancellationToken)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 62:

ReadAnyAsync(UInt32, Type, Int32, CancellationToken)

Reads data synchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 63:

ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 64:

ReadAnyAsync(UInt32, UInt32, Type, Int32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 65:

ReadAnyAsyncT(String, CancellationToken)

Reads data asynchronously from an ADS device.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 66:

ReadAnyAsyncT(UInt32, CancellationToken)

Reads data asynchronously from an ADS device.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 67:

ReadAnyAsyncT(String, Int32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 68:

ReadAnyAsyncT(UInt32, Int32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 69:

ReadAnyAsyncT(UInt32, UInt32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 70:

ReadAnyAsyncT(UInt32, UInt32, Int32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 71:

ReadAnyString(String, Int32, Encoding)

Reads any string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 72:

ReadAnyString(UInt32, Int32, Encoding)

Reads a string from the specified symbol/variable.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 73:

ReadAnyString(UInt32, UInt32, Int32, Encoding)

Reads as string from a specified address.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 74:

ReadAnyStringAsync(String, Int32, Encoding, CancellationToken)

Reads a string asynchronously from the specified symbol/variable
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 75:

ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)

Reads a string asynchronously from the specified symbol/variable
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 76:

ReadAnyStringAsync(UInt32, UInt32, Int32, Encoding, CancellationToken)

Reads a string from a specified address asynchronously.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 77:

ReadAsResult(UInt32, Int32)

Reads the value synchronously data of the symbol, that is represented by the variable handle./>.
(Inherited from IAdsHandle)

IAdsConnection Interface 78:

ReadAsResult(UInt32, UInt32, Int32)

Reads data synchronously from an ADS device.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 79:

ReadDataType

Reads/Determines the DataType Inforrmation with the specifed name.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 80:

ReadDataTypeAsync

Reads/Determines the DataType of the specified type as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 81:

ReadDeviceInfo

Reads the identification and version number of an ADS server.

IAdsConnection Interface 82:

ReadDeviceInfoAsync

Reads the identification and version number of an ADS server.

IAdsConnection Interface 83:

ReadState

Reads the ADS status and the device status from an ADS server.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 84:

ReadStateAsync

Reads the ADS status and the device status from an ADS server.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 85:

ReadSymbol

Reads the symbol information about an individual variable in ADS devices.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 86:

ReadSymbolAsync

Reads the symbol information object specified by the instance path as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 87:

ReadValue(ISymbol)

Reads the value of a symbol and returns the value as (boxed) object.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 88:

ReadValue(String)

Reads the value of a symbol specified with its instance path and returns the value as boxed object.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 89:

ReadValue(String, Type)

Reads the value of a symbol specified with its instance path and returns the value as object of the specified type.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 90:

ReadValueAsync(ISymbol, CancellationToken)

Reads the value of a symbol as an asynchronous operation and returns the value as an (boxed) object.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 91:

ReadValueAsync(String, Type, CancellationToken)

Reads the typed value of a symbol as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 92:

ReadValueAsyncT(String, CancellationToken)

Reads the typed value of a symbol specified by the instance path as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 93:

ReadWrite

Writes data synchronously to an ADS device and then Reads data from that target.
(Inherited from IAdsHandle)

IAdsConnection Interface 94:

ReadWriteAsResult

Writes data synchronously to an ADS device and reads data from that device.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 95:

ReadWriteAsync

ReadWrites value data asynchronously to/from the symbol represented by the variableHandle.
(Inherited from IAdsHandle)

IAdsConnection Interface 96:

RegisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 97:

RegisterSymbolVersionChanged

Registers the symbol version changed event (synchronously)
(Inherited from IAdsSymbolChangedProvider)

IAdsConnection Interface 98:

RegisterSymbolVersionChangedAsync

Registers the symbol version changed asynchronously.
(Inherited from IAdsSymbolChangedProvider)

IAdsConnection Interface 99:

TryAddDeviceNotification(String, Int32, NotificationSettings, Object, UInt32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 100:

TryAddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object, UInt32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 101:

TryAddDeviceNotificationEx(String, NotificationSettings, Object, Type, Int32, UInt32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 102:

TryAddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32, UInt32)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
(Inherited from IAdsNotifications)

IAdsConnection Interface 103:

TryCreateVariableHandle

Determines the Symbol handle by its instance path synchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 104:

TryDeleteDeviceNotification

Deletes a registered notification.
(Inherited from IAdsNotifications)

IAdsConnection Interface 105:

TryDeleteVariableHandle

Releases the specified symbol/variable handle synchronously.
(Inherited from IAdsHandle)

IAdsConnection Interface 106:

IAdsConnection Interface 107:

TryInvokeRpcMethod(String, String, Object, Object)

Invokes the specified RPC Method
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 108:

IAdsConnection Interface 109:

TryInvokeRpcMethod(String, String, Object, Object, Object)

Invokes the specified RPC Method
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 110:

IAdsConnection Interface 111:

TryInvokeRpcMethod(IRpcCallableInstance, IRpcMethod, Object, AnyTypeSpecifier, AnyTypeSpecifier, Object, Object)

Invokes the rpc method.
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 112:

IAdsConnection Interface 113:

TryInvokeRpcMethod(String, String, Object, AnyTypeSpecifier, AnyTypeSpecifier, Object, Object)

Invokes the rpc method.
(Inherited from IAdsRpcInvoke)

IAdsConnection Interface 114:

TryRead

Reads the value synchronously data of the symbol, that is represented by the variable handle into the readBuffer.
(Inherited from IAdsHandle)

IAdsConnection Interface 115:

TryReadDataType

Tries to Read/Determine the DataType of the specified type.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 116:

TryReadState

Reads the ADS status and the device status from an ADS server. Unlike the ReadState method this method does not call an exception on failure. Instead an AdsErrorCode is returned. If the return value is equal to AdsErrorCode.NoError the call was successful.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 117:

TryReadSymbol

Tries to read the symbol information object specified by the instance path.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 118:

TryReadValue(ISymbol, Object)

Tries to read the value of a symbol and returns the value as boxed object.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 119:

TryReadValue(String, Type, Object)

Tries to the value of a symbol specified as instance path and returns the value as (boxed) object.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 120:

TryReadValueT(ISymbol, T)

Reads the value of a symbol and returns the value as typed value.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 121:

TryReadValueT(String, T)

Tries to reads the value of a symbol specified with instance path and returns the typed value.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 122:

TryReadWrite

ReadWrites value data synchronously to/from the symbol represented by the variableHandle.
(Inherited from IAdsHandle)

IAdsConnection Interface 123:

TryWrite(UInt32, ReadOnlyMemoryByte)

Writes the value data synchronously that is represented in the writeBuffer to the symbol with the specified variableHandle.
(Inherited from IAdsHandle)

IAdsConnection Interface 124:

TryWrite(UInt32, UInt32, ReadOnlyMemoryByte)

Writes data synchronously to an ADS device.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 125:

TryWriteControl(StateInfo)

Changes the ADS status and the device status of an ADS server.
(Inherited from IAdsStateControl)

IAdsConnection Interface 126:

TryWriteControl(StateInfo, ReadOnlyMemoryByte)

Changes the ADS status and the device status of an ADS server.
(Inherited from IAdsStateControl)

IAdsConnection Interface 127:

TryWriteValue(ISymbol, Object)

Tries to write a (boxed) value to the symbol
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 128:

TryWriteValue(String, Object)

Tries to write a (boxed) value to the symbol instance specified by its instance/symbol path.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 129:

TryWriteValueT(ISymbol, T)

Tries to write a value to the symbol.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 130:

TryWriteValueT(String, T)

Tries to Write a (typed) value to the symbol instance specified by its instance/symbol path.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 131:

UnregisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 132:

UnregisterSymbolVersionChanged

Unregisters the symbol version changed event (synchronously)
(Inherited from IAdsSymbolChangedProvider)

IAdsConnection Interface 133:

UnregisterSymbolVersionChangedAsync

Unregisters the symbol version changed asynchronously.
(Inherited from IAdsSymbolChangedProvider)

IAdsConnection Interface 134:

Write(UInt32, ReadOnlyMemoryByte)

Writes data synchronously to an ADS device.
(Inherited from IAdsHandle)

IAdsConnection Interface 135:

Write(UInt32, UInt32)

Sends a 'Write' request to the ADS device at the specified address.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 136:

Write(UInt32, UInt32, ReadOnlyMemoryByte)

Writes data synchronously to an ADS device.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 137:

WriteAny(UInt32, Object)

Writes an object synchronously to an ADS device.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 138:

WriteAny(UInt32, Object, Int32)

Writes an object synchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 139:

WriteAny(UInt32, UInt32, Object)

Writes an object synchronously to an ADS device.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 140:

WriteAny(UInt32, UInt32, Object, Int32)

Writes an object synchronously to an ADS device.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 141:

WriteAnyAsync(UInt32, Object, CancellationToken)

Writes an object synchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 142:

WriteAnyAsync(UInt32, Object, Int32, CancellationToken)

Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 143:

WriteAnyAsync(UInt32, UInt32, Object, CancellationToken)

Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 144:

WriteAnyAsync(UInt32, UInt32, Object, Int32, CancellationToken)

Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
(Inherited from IAdsAnyAccess)

IAdsConnection Interface 145:

WriteAsResult

Writes data synchronously to an ADS device.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 146:

WriteAsync(UInt32, ReadOnlyMemoryByte, CancellationToken)

Writes the value data asynchronously that is represented by the writeBuffer to the symbol specified by the variableHandle.
(Inherited from IAdsHandle)

IAdsConnection Interface 147:

WriteAsync(UInt32, UInt32, ReadOnlyMemoryByte, CancellationToken)

Writes the data / Value asynchronously into the specified writeBuffer.
(Inherited from IAdsReadWrite)

IAdsConnection Interface 148:

WriteControl(StateInfo)

Changes the ADS status and the device status of an ADS server.
(Inherited from IAdsStateControl)

IAdsConnection Interface 149:

WriteControl(StateInfo, ReadOnlyMemoryByte)

Changes the ADS status and the device status of an ADS server.
(Inherited from IAdsStateControl)

IAdsConnection Interface 150:

WriteControlAsync(AdsState, UInt16, CancellationToken)

Changes the ADS status and device status of the ADS server asynchronously.
(Inherited from IAdsStateControl)

IAdsConnection Interface 151:

WriteControlAsync(AdsState, UInt16, ReadOnlyMemoryByte, CancellationToken)

Changes the ADS status and device status of the ADS server asynchronously.
(Inherited from IAdsStateControl)

IAdsConnection Interface 152:

WriteValue(ISymbol, Object)

Writes a (boxed) value to the symbol.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 153:

WriteValue(String, Object)

Writes a (boxed value) to the symbol instance specified by its instance/symbol path.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 154:

WriteValueT(ISymbol, T)

Writes a (typed) value to the symbol.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 155:

WriteValueT(String, T)

Writes a typed value to the symbol instance specified by its instance/symbol path.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 156:

WriteValueAsync(ISymbol, Object, CancellationToken)

Writes a (boxed) value to the symbol as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 157:

WriteValueAsyncT(ISymbol, T, CancellationToken)

Writes a (typed) value to the symbol as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

IAdsConnection Interface 158:

WriteValueAsyncT(String, T, CancellationToken)

Writes a (typed) value to the symbol instance specified by its instance/symbol path as an asynchronous operation.
(Inherited from IAdsSymbolicAccess)

Events

 

Name

Description

IAdsConnection Interface 159:

IAdsConnection Interface 160:

AdsNotification

Occurs when the ADS device sends a notification to the client.
(Inherited from IAdsNotifications)

IAdsConnection Interface 161:

AdsNotificationError

Occurs when a exception has occurred during notification management.
(Inherited from IAdsNotifications)

IAdsConnection Interface 162:

IAdsConnection Interface 163:

AdsNotificationEx

Occurs when the ADS devices sends a notification to the client.
(Inherited from IAdsNotifications)

IAdsConnection Interface 164:

AdsStateChanged

Occurs when the AdsState of the target system has been changed.
(Inherited from IAdsStateProvider)

IAdsConnection Interface 165:

IAdsConnection Interface 166:

AdsSumNotification

Occurs when Notifications are send (bundled notifications)
(Inherited from IAdsNotifications)

IAdsConnection Interface 167:

AdsSymbolVersionChanged

Occurs when the SymbolVersion table of a TwinCAT PLC System has been changed.
(Inherited from IAdsSymbolChangedProvider)

IAdsConnection Interface 168:

IAdsConnection Interface 169:

ConnectionStateChanged

Occurs when connection status of the IConnectionStateProvider has been changed.
(Inherited from IConnectionStateProvider)

Extension Methods

 

Name

Description

PollAdsState

Gets an observable sequence of ResultReadAdsStates via Polling.
(Defined by ConnectionStateExtension)

PollAdsState

Gets an observable sequence of AdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsState

Gets an observable sequence of ResultReadAdsStates via Polling.
(Defined by ConnectionStateExtension)

PollAdsState

Gets an observable sequence of AdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsState2

Gets an observable sequence of ResultReadAdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsState2

Gets an observable sequence of ResultReadAdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsState2Async

Gets an observable sequence of AdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsState2Async

Gets an observable sequence of ResultReadAdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsStateAsync

Gets an observable sequence of AdsStates via Polling.
(Defined by ConnectionStateExtension)

PollAdsStateAsync

Gets an observable sequence of AdsStates via Polling.
(Defined by AdsClientExtensions)

PollAdsStateAsync

Gets an observable sequence of AdsStates via Polling.
(Defined by ConnectionStateExtension)

PollAdsStateAsync

Gets an observable sequence of AdsStates via Polling.
(Defined by AdsClientExtensions)

PollDeviceState

Gets an observable sequence of ResultReadDeviceStates via Polling.
(Defined by AdsClientExtensions)

PollDeviceState

Gets an observable sequence of ResultReadDeviceStates via Polling.
(Defined by AdsClientExtensions)

PollDeviceStateAsync

Gets an observable sequence of ResultReadDeviceStates via Polling.
(Defined by AdsClientExtensions)

PollDeviceStateAsync

Gets an observable sequence of ResultReadDeviceStates via Polling.
(Defined by AdsClientExtensions)

PollSystemServiceState

Polls the state of the system service.
(Defined by SystemServiceExtension)

PollSystemServiceStateAsync

Polls the system service state asynchronously
(Defined by SystemServiceExtension)

PollValues

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol values on time points where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol values on time points where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on time points where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on time points where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValuesT

Polls the symbol as value sequence of object values with a specified period time.
(Defined by AnyTypeExtensions)

PollValues2T

Polls the symbol values on timepoints where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

PollValues2T

Polls the symbol values on time points where the polling observable streams data / triggers
(Defined by AnyTypeExtensions)

ReadSysServState

Reads the System Service state (AdsSysServState)
(Defined by SystemServiceExtension)

ReadSysServStateAsync

Reads the System Service state (AdsSysServState) (asynchronous)
(Defined by SystemServiceExtension)

ReadWithFallback

Read with fallback.
(Defined by AdsClientExtensions)

ReadWithFallback

Ads Read with Fallback.
(Defined by AdsClientExtensions)

ReadWithFallback

Ads Read with Fallback.
(Defined by AdsClientExtensions)

ReadWithFallbackAsync

Ads Read with fallback as an asynchronous operation.
(Defined by AdsClientExtensions)

ReadWithFallbackAsync

Ads Read with fallback as an asynchronous operation.
(Defined by AdsClientExtensions)

ReadWithFallbackAsync

Ads Read with fallback as an asynchronous operation.
(Defined by AdsClientExtensions)

ReadWriteWithFallback

Ads Read with Fallback.
(Defined by AdsClientExtensions)

ReadWriteWithFallback

ReadWrite with Fallback.
(Defined by AdsClientExtensions)

ReadWriteWithFallbackAsync

Ads Read with fallback as an asynchronous operation.
(Defined by AdsClientExtensions)

ReadWriteWithFallbackAsync

Ads Read with fallback as an asynchronous operation.
(Defined by AdsClientExtensions)

RepeatedRead

Repeated AdsRead.
(Defined by AdsClientExtensions)

RepeatedRead

Repeated AdsRead.
(Defined by AdsClientExtensions)

RepeatedReadAsync

Repeated AdsRead as an asynchronous operation.
(Defined by AdsClientExtensions)

RepeatedReadAsync

Repeated AdsRead as an asynchronous operation.
(Defined by AdsClientExtensions)

RepeatedReadWrite

Repeated AdsRead.
(Defined by AdsClientExtensions)

RepeatedReadWriteAsync

Repeated AdsReadWrite as an asynchronous operation.
(Defined by AdsClientExtensions)

RepeatedWrite

Repeated AdsWrie.
(Defined by AdsClientExtensions)

RepeatedWriteAsync

Repeated AdsReadWrite as an asynchronous operation.
(Defined by AdsClientExtensions)

RestartTwinCATAsync

Sends a SystemService Restart to the target system and waits until the system has finished the state changes (SystemService, Port 10000) (asynchronously)
(Defined by SystemServiceExtension)

SetAdsState

Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails.
(Defined by ConnectionStateExtension)

SetAdsStateAsync

Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails (asynchronously)
(Defined by ConnectionStateExtension)

WaitForTargetState

Waits until the target AdsServer reaches the requested state.
(Defined by ConnectionStateExtension)

WaitForTargetStateAsync

Waits until the target AdsServer reaches the requested state (asynchronous)
(Defined by ConnectionStateExtension)

WaitUntilRestarted

Waits until the Restart is detected on the client (SystemService, Port 10000)
(Defined by SystemServiceExtension)

WaitUntilRestartedAsync

Waits until the SystemService Restart is detectd on the client (SystemService, Port 10000) (asynchronously)
(Defined by SystemServiceExtension)

WhenAdsStateChanges

Gets an observable sequence of AdsStates.
(Defined by AdsClientExtensions)

WhenNotification

Gets an observable sequence of Notifications.
(Defined by AdsClientExtensions)

WhenNotification

Gets an observable sequence of Notification objects.
(Defined by AdsClientExtensions)

WhenNotification

Gets an observable sequence of Notification objects.
(Defined by AdsClientExtensions)

WhenNotification

Gets an observable sequence of SymbolValueNotifications.
(Defined by AdsClientExtensions)

WhenNotification

Creates an observable sequence of values that are created by ADS Notifications.
(Defined by AnyTypeExtensions)

WhenNotificationT

Creates an observable sequence of values that are created by ADS Notifications.
(Defined by AnyTypeExtensions)

WhenSymbolVersionChanges

Gets an observable sequence of SymbolVersion changed counts.
(Defined by AdsClientExtensions)

WhenSymbolVersionChanges

Gets an observable sequence of SymbolVersion changed counts.
(Defined by AdsClientExtensions)

WhenValueChanged

Observable sequence of Values driven by ADS Notifications on the specified symbol.
(Defined by ValueSymbolExtensions)

WriteValuesT

Writes the sequence of values to the symbol specified by the instance path.
(Defined by AnyTypeExtensions)

WriteValuesT

Writes the sequence of values to the symbol specified by the instance path.
(Defined by AnyTypeExtensions)

Remarks

The ADS connection interface represents the the logical point-to-point exception between Client and Server within an ADS Session.

Reference

TwinCAT.Ads Namespace IConnection IAdsNotifications IAdsAnyAccess IAdsHandle IAdsReadWrite IAdsStateControl

Beckhoff Automation GmbH & Co. KG 2001-2026