IAdsConnection Interface

ADS Connection interface

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public interface IAdsConnection : IConnection, 
    IConnectionStateProvider, IAdsNotifications, IAdsSymbolicAccess, IAdsAnyAccess, IAdsHandle, 
    IAdsReadWrite2, 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:

ClientAddress

Get the AmsAddress of the ADS client.

IAdsConnection Interface 3:

IAdsConnection Interface 4:

ConnectionState

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

IAdsConnection Interface 5:

DefaultValueEncoding

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

IAdsConnection Interface 6:

Id

Gets the Connection Identifier . (Inherited from IConnection.)

IAdsConnection Interface 7:

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

IsLocal

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

IAdsConnection Interface 9:

Session

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

IAdsConnection Interface 10:

Timeout

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

Methods

 

Name

Description

IAdsConnection Interface 11:

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

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

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

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

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

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

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

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

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

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

CleanupSymbolTable

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

IAdsConnection Interface 22:

Close

Closes this IConnection (Inherited from IConnection.)

IAdsConnection Interface 23:

Connect

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

IAdsConnection Interface 24:

CreateVariableHandle

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

IAdsConnection Interface 25:

CreateVariableHandleAsync

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

IAdsConnection Interface 26:

DeleteDeviceNotification

Deletes a registered notification. (Inherited from IAdsNotifications.)

IAdsConnection Interface 27:

DeleteDeviceNotificationAsync

Deletes a registered notification asynchronously. (Inherited from IAdsNotifications.)

IAdsConnection Interface 28:

DeleteVariableHandle

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

IAdsConnection Interface 29:

DeleteVariableHandleAsync

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

IAdsConnection Interface 30:

Disconnect

Disconnects this IConnection. (Inherited from IConnection.)

IAdsConnection Interface 31:

IAdsConnection Interface 32:

InvokeRpcMethodAsync(String, String, .Object., CancellationToken)

Invokes the specified RPC Method asynchronously (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 33:

IAdsConnection Interface 34:

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

Invokes the specified RPC Method asynchronously (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 35:

IAdsConnection Interface 36:

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

Invokes the specified RPC Method asynchronously (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 37:

Read(UInt32, Memory.Byte.)

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

IAdsConnection Interface 38:

Read(UInt32, UInt32, Memory.Byte.)

Reads data synchronously from an ADS device and writes it to the given readBuffer (Inherited from IAdsReadWrite2.)

IAdsConnection Interface 39:

ReadAny(UInt32, Type)

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

IAdsConnection Interface 40:

ReadAny(UInt32, Type, .Int32.)

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

IAdsConnection Interface 41:

ReadAny(UInt32, UInt32, Type)

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

IAdsConnection Interface 42:

ReadAny(UInt32, UInt32, Type, .Int32.)

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

IAdsConnection Interface 43:

ReadAny.T.(UInt32)

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

IAdsConnection Interface 44:

ReadAny.T.(UInt32, .Int32.)

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

IAdsConnection Interface 45:

ReadAny.T.(UInt32, UInt32)

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

IAdsConnection Interface 46:

ReadAny.T.(UInt32, UInt32, .Int32.)

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

IAdsConnection Interface 47:

ReadAnyAsync(UInt32, Type, CancellationToken)

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

IAdsConnection Interface 48:

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

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

IAdsConnection Interface 49:

ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)

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

IAdsConnection Interface 50:

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

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

IAdsConnection Interface 51:

ReadAnyAsync.T.(UInt32, CancellationToken)

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

IAdsConnection Interface 52:

ReadAnyAsync.T.(UInt32, .Int32., CancellationToken)

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

IAdsConnection Interface 53:

ReadAnyAsync.T.(UInt32, UInt32, CancellationToken)

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

IAdsConnection Interface 54:

ReadAnyAsync.T.(UInt32, UInt32, .Int32., CancellationToken)

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

IAdsConnection Interface 55:

ReadAnyString(UInt32, Int32, Encoding)

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

IAdsConnection Interface 56:

ReadAnyString(UInt32, UInt32, Int32, Encoding)

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

IAdsConnection Interface 57:

ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)

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

IAdsConnection Interface 58:

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

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

IAdsConnection Interface 59:

ReadAsync(UInt32, Memory.Byte., CancellationToken)

Reads the value data of the symbol asynchronously into the readBuffer. (Inherited from IAdsHandle.)

IAdsConnection Interface 60:

ReadAsync(UInt32, UInt32, Memory.Byte., CancellationToken)

Reads the data asynchronously from specified IndexGroup/IndexOffset (Inherited from IAdsReadWrite.)

IAdsConnection Interface 61:

ReadDataType

Call this method to obtain information about the specified data type. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 62:

ReadDataTypeAsync

Call this method to obtain information about the specified data type. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 63:

ReadDeviceInfo

Reads the identification and version number of an ADS server.

IAdsConnection Interface 64:

ReadDeviceInfoAsync

Reads the identification and version number of an ADS server.

IAdsConnection Interface 65:

ReadState

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

IAdsConnection Interface 66:

ReadStateAsync

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

IAdsConnection Interface 67:

ReadSymbol

Call this method to obtain information about the individual symbols (variables) in ADS devices. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 68:

ReadSymbolAsync

Call this method to obtain information about the individual symbols (variables) in ADS devices. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 69:

ReadValue(ISymbol)

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

IAdsConnection Interface 70:

ReadValue(String, Type)

Reads the value of a symbol and returns the value as object. The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 71:

ReadValue.T.(String)

Reads the value of a symbol and returns the value. The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 72:

ReadValueAsync(ISymbol, CancellationToken)

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

IAdsConnection Interface 73:

ReadValueAsync(String, Type, CancellationToken)

Reads the value of a symbol asynchronously. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 74:

ReadValueAsync.T.(String, CancellationToken)

Reads the value of a symbol asynchronously. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 75:

ReadWrite(UInt32, Memory.Byte., ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 76:

ReadWrite(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte.)

Writes data synchronously to an ADS device and then Reads data from this device into the readBuffer (Inherited from IAdsReadWrite2.)

IAdsConnection Interface 77:

ReadWriteAsync(UInt32, Memory.Byte., ReadOnlyMemory.Byte., CancellationToken)

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

IAdsConnection Interface 78:

ReadWriteAsync(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte., CancellationToken)

Read/Writes data asynchronously to/from the specified writeBuffer, readBuffer (Inherited from IAdsReadWrite.)

IAdsConnection Interface 79:

RegisterAdsStateChangedAsync

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

IAdsConnection Interface 80:

RegisterSymbolVersionChanged

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

IAdsConnection Interface 81:

RegisterSymbolVersionChangedAsync

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

IAdsConnection Interface 82:

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

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

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

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

TryCreateVariableHandle

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

IAdsConnection Interface 87:

TryDeleteDeviceNotification

Deletes a registered notification. (Inherited from IAdsNotifications.)

IAdsConnection Interface 88:

TryDeleteVariableHandle

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

IAdsConnection Interface 89:

IAdsConnection Interface 90:

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

Invokes the specified RPC Method (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 91:

IAdsConnection Interface 92:

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

Invokes the specified RPC Method (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 93:

IAdsConnection Interface 94:

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

Invokes the rpc method. (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 95:

IAdsConnection Interface 96:

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

Invokes the rpc method. (Inherited from IAdsRpcInvoke.)

IAdsConnection Interface 97:

TryRead(UInt32, Memory.Byte., Int32.)

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

IAdsConnection Interface 98:

TryRead(UInt32, UInt32, Memory.Byte., Int32.)

Reads data synchronously from an ADS device and writes it to the given stream. (Inherited from IAdsReadWrite.)

IAdsConnection Interface 99:

TryReadDataType

Call this method to obtain information about the specified data type. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 100:

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

TryReadSymbol

Call this method to obtain information about the individual symbols (variables) in ADS devices. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 102:

TryReadValue(ISymbol, Object.)

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

IAdsConnection Interface 103:

TryReadValue(String, Type, Object.)

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

IAdsConnection Interface 104:

TryReadValue.T.(ISymbol, T.)

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

IAdsConnection Interface 105:

TryReadValue.T.(String, T.)

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

IAdsConnection Interface 106:

TryReadWrite(UInt32, Memory.Byte., ReadOnlyMemory.Byte., Int32.)

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

IAdsConnection Interface 107:

TryReadWrite(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte., Int32.)

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

IAdsConnection Interface 108:

TryWrite(UInt32, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 109:

TryWrite(UInt32, UInt32, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 110:

TryWriteControl(StateInfo)

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

IAdsConnection Interface 111:

TryWriteControl(StateInfo, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 112:

TryWriteValue(ISymbol, Object)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 113:

TryWriteValue(String, Object)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 114:

TryWriteValue.T.(ISymbol, T)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 115:

TryWriteValue.T.(String, T)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 116:

UnregisterAdsStateChangedAsync

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

IAdsConnection Interface 117:

UnregisterSymbolVersionChanged

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

IAdsConnection Interface 118:

UnregisterSymbolVersionChangedAsync

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

IAdsConnection Interface 119:

Write(UInt32, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 120:

Write(UInt32, UInt32)

Triggers a 'Write' call to the ADS device at the specified address. (Inherited from IAdsReadWrite2.)

IAdsConnection Interface 121:

Write(UInt32, UInt32, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 122:

WriteAny(UInt32, Object)

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

IAdsConnection Interface 123:

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

WriteAny(UInt32, UInt32, Object)

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

IAdsConnection Interface 125:

WriteAny(UInt32, UInt32, Object, .Int32.)

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

IAdsConnection Interface 126:

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

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

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

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

WriteAsync(UInt32, ReadOnlyMemory.Byte., CancellationToken)

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

IAdsConnection Interface 131:

WriteAsync(UInt32, UInt32, ReadOnlyMemory.Byte., CancellationToken)

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

IAdsConnection Interface 132:

WriteControl(StateInfo)

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

IAdsConnection Interface 133:

WriteControl(StateInfo, ReadOnlyMemory.Byte.)

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

IAdsConnection Interface 134:

WriteControlAsync(AdsState, UInt16, CancellationToken)

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

IAdsConnection Interface 135:

WriteControlAsync(AdsState, UInt16, ReadOnlyMemory.Byte., CancellationToken)

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

IAdsConnection Interface 136:

WriteValue(ISymbol, Object)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 137:

WriteValue(String, Object)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 138:

WriteValue.T.(ISymbol, T)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 139:

WriteValue.T.(String, T)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 140:

WriteValueAsync(ISymbol, Object, CancellationToken)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 141:

WriteValueAsync.T.(ISymbol, T, CancellationToken)

Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol. (Inherited from IAdsSymbolicAccess.)

IAdsConnection Interface 142:

WriteValueAsync.T.(String, T, CancellationToken)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same binary layout as the ADS symbol. (Inherited from IAdsSymbolicAccess.)

Events

 

Name

Description

IAdsConnection Interface 143:

IAdsConnection Interface 144:

AdsNotification

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

IAdsConnection Interface 145:

AdsNotificationError

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

IAdsConnection Interface 146:

IAdsConnection Interface 147:

AdsNotificationEx

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

IAdsConnection Interface 148:

AdsStateChanged

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

IAdsConnection Interface 149:

IAdsConnection Interface 150:

AdsSumNotification

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

IAdsConnection Interface 151:

AdsSymbolVersionChanged

Occurs when the ADS Symbol Version changed. (Inherited from IAdsSymbolChangedProvider.)

IAdsConnection Interface 152:

IAdsConnection Interface 153:

ConnectionStateChanged

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

Extension Methods

 

Name

Description

IAdsConnection Interface 154:

PollAdsState(IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 155:

IAdsConnection Interface 156:

PollAdsState(IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 157:

IAdsConnection Interface 158:

PollAdsState(TimeSpan)

Overloaded.

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

IAdsConnection Interface 159:

IAdsConnection Interface 160:

PollAdsState(TimeSpan)

Overloaded.

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

IAdsConnection Interface 161:

PollAdsState2(IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 162:

IAdsConnection Interface 163:

PollAdsState2(TimeSpan)

Overloaded.

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

IAdsConnection Interface 164:

PollAdsState2Async(IObservable.Unit., CancellationToken)

Overloaded.

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

IAdsConnection Interface 165:

PollAdsState2Async(TimeSpan, CancellationToken)

Overloaded.

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

IAdsConnection Interface 166:

IAdsConnection Interface 167:

PollAdsStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

IAdsConnection Interface 168:

IAdsConnection Interface 169:

PollAdsStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

IAdsConnection Interface 170:

IAdsConnection Interface 171:

PollAdsStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

IAdsConnection Interface 172:

IAdsConnection Interface 173:

PollAdsStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

IAdsConnection Interface 174:

PollDeviceState(IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 175:

IAdsConnection Interface 176:

PollDeviceState(TimeSpan)

Overloaded.

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

IAdsConnection Interface 177:

IAdsConnection Interface 178:

PollDeviceStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

IAdsConnection Interface 179:

IAdsConnection Interface 180:

PollDeviceStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

IAdsConnection Interface 181:

PollSystemServiceState

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

IAdsConnection Interface 182:

PollSystemServiceStateAsync

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

IAdsConnection Interface 183:

PollValues(ISymbol, Type, IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 184:

PollValues(ISymbol, Type, TimeSpan)

Overloaded.

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

IAdsConnection Interface 185:

PollValues(String, Type, IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 186:

PollValues(String, Type, TimeSpan)

Overloaded.

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

IAdsConnection Interface 187:

PollValues(ISymbol, Type, .Int32., TimeSpan)

Overloaded.

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

IAdsConnection Interface 188:

PollValues(ISymbol, Type, IObservable.Unit., Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 189:

PollValues(ISymbol, Type, TimeSpan, Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 190:

PollValues(String, Type, .Int32., TimeSpan)

Overloaded.

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

IAdsConnection Interface 191:

PollValues(String, Type, IObservable.Unit., Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 192:

PollValues(String, Type, TimeSpan, Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 193:

PollValues(ISymbol, Type, .Int32., IObservable.Unit., Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 194:

PollValues(ISymbol, Type, .Int32., TimeSpan, Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 195:

PollValues(String, Type, .Int32., IObservable.Unit., Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 196:

PollValues(String, Type, .Int32., TimeSpan, Func.Exception, Object.)

Overloaded.

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

IAdsConnection Interface 197:

PollValues.T.(ISymbol, IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 198:

PollValues.T.(ISymbol, TimeSpan)

Overloaded.

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

IAdsConnection Interface 199:

PollValues.T.(String, IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 200:

PollValues.T.(String, TimeSpan)

Overloaded.

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

IAdsConnection Interface 201:

PollValues.T.(ISymbol, IObservable.Unit., Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 202:

PollValues.T.(ISymbol, TimeSpan, Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 203:

PollValues.T.(ISymbol, .Int32., IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 204:

IAdsConnection Interface 205:

PollValues.T.(ISymbol, .Int32., TimeSpan)

Overloaded.

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

IAdsConnection Interface 206:

PollValues.T.(String, IObservable.Unit., Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 207:

PollValues.T.(String, TimeSpan, Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 208:

PollValues.T.(String, .Int32., IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 209:

IAdsConnection Interface 210:

PollValues.T.(String, .Int32., TimeSpan)

Overloaded.

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

IAdsConnection Interface 211:

PollValues.T.(ISymbol, .Int32., IObservable.Unit., Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 212:

IAdsConnection Interface 213:

PollValues.T.(ISymbol, .Int32., TimeSpan, Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 214:

PollValues.T.(String, .Int32., IObservable.Unit., Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 215:

IAdsConnection Interface 216:

PollValues.T.(String, .Int32., TimeSpan, Func.Exception, T.)

Overloaded.

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

IAdsConnection Interface 217:

PollValues2.T.(ISymbol, .Int32., IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 218:

PollValues2.T.(String, .Int32., IObservable.Unit.)

Overloaded.

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

IAdsConnection Interface 219:

ReadSysServState

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

IAdsConnection Interface 220:

ReadSysServStateAsync

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

IAdsConnection Interface 221:

ReadWithFallback(UInt32, UInt32, Memory.Byte., UInt32, Boolean.)

Overloaded.

Ads Read with fallback. (Defined by AdsClientExtensions.)

IAdsConnection Interface 222:

ReadWithFallback(UInt32, UInt32, UInt32, Memory.Byte., Func.ResultRead, Boolean., Boolean.)

Overloaded.

Ads Read with Fallback. (Defined by AdsClientExtensions.)

IAdsConnection Interface 223:

ReadWithFallbackAsync(UInt32, UInt32, UInt32, Memory.Byte., CancellationToken)

Overloaded.

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

IAdsConnection Interface 224:

ReadWithFallbackAsync(UInt32, UInt32, UInt32, Memory.Byte., Func.ResultRead, Boolean., CancellationToken)

Overloaded.

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

IAdsConnection Interface 225:

RepeatedRead(UInt32, UInt32, Memory.Byte., Int32, TimeSpan)

Overloaded.

Repeated AdsRead. (Defined by AdsClientExtensions.)

IAdsConnection Interface 226:

RepeatedRead(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, Func.ResultRead, Boolean.)

Overloaded.

Repeated AdsRead. (Defined by AdsClientExtensions.)

IAdsConnection Interface 227:

RepeatedReadAsync(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, CancellationToken)

Overloaded.

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

IAdsConnection Interface 228:

RepeatedReadAsync(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, Func.ResultRead, Boolean., CancellationToken)

Overloaded.

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

IAdsConnection Interface 229:

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.)

IAdsConnection Interface 230:

SetAdsState

Sets an AdsState/AdsStateCommand to an AdsServer and waits until the StateChange finishes. (Defined by ConnectionStateExtension.)

IAdsConnection Interface 231:

SetAdsStateAsync

Sets an AdsState/AdsStateCommand to an AdsServer and waits until the StateChange finishes. (Defined by ConnectionStateExtension.)

IAdsConnection Interface 232:

WaitUntilRestarted

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

IAdsConnection Interface 233:

WaitUntilRestartedAsync

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

IAdsConnection Interface 234:

IAdsConnection Interface 235:

WhenAdsStateChanges

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

IAdsConnection Interface 236:

WhenNotification(ISymbol)

Overloaded.

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

IAdsConnection Interface 237:

IAdsConnection Interface 238:

WhenNotification(ISymbolCollection)

Overloaded.

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

IAdsConnection Interface 239:

IAdsConnection Interface 240:

WhenNotification(IList.ISymbol., NotificationSettings)

Overloaded.

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

IAdsConnection Interface 241:

WhenNotification(ISymbol, NotificationSettings)

Overloaded.

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

IAdsConnection Interface 242:

IAdsConnection Interface 243:

WhenNotification(String, Type, NotificationSettings)

Overloaded.

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

IAdsConnection Interface 244:

IAdsConnection Interface 245:

WhenNotification.T.(String, NotificationSettings)

Overloaded.

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

IAdsConnection Interface 246:

WhenSymbolVersionChanges.

Overloaded.

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

IAdsConnection Interface 247:

WhenSymbolVersionChanges(IScheduler)

Overloaded.

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

IAdsConnection Interface 248:

IAdsConnection Interface 249:

WhenValueChanged

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

IAdsConnection Interface 250:

IAdsConnection Interface 251:

WriteValues.T.(String, IObservable.T.)

Overloaded.

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

IAdsConnection Interface 252:

IAdsConnection Interface 253:

WriteValues.T.(String, IObservable.T., Action.Exception.)

Overloaded.

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

TwinCAT.IConnection

TwinCAT.Ads.IAdsNotifications

TwinCAT.Ads.IAdsAnyAccess

TwinCAT.Ads.IAdsHandle

TwinCAT.Ads.IAdsReadWrite2

TwinCAT.Ads.IAdsStateControl