AdsConnection Class

ADS Connection class

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.AdsConnection
Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

public sealed class AdsConnection : IAdsConnection, 
    IConnection, IConnectionStateProvider, IAdsNotifications, IAdsSymbolicAccess, IAdsAnyAccess, 
    IAdsHandle, IAdsReadWrite2, IAdsReadWrite, IAdsStateProvider, IAdsStateControl, 
    IAdsSymbolChangedProvider, IAdsRpcInvoke, IAdsReadWriteTimeoutAccess, IAdsStateControlTimeout, IDisposable

The AdsConnection type exposes the following members.

Properties

 

Name

Description

AdsConnection Class 1:

AccessWaitTime

Gets the access wait time.

AdsConnection Class 2:

ActiveSince

Gets the UTC time when tha last active/resurrected Connection was established

AdsConnection Class 3:

Address

Gets the AmsAddress of the ADS server.

AdsConnection Class 4:

ClientAddress

Get the AmsAddress of the ADS client.

AdsConnection Class 5:

ConnectionEstablishedAt

Gets the UTC time when the Connection was originally established.

AdsConnection Class 6:

ConnectionLostTime

Gets the connection lost time.

AdsConnection Class 7:

AdsConnection Class 8:

ConnectionState

Gets the current Connection state of the AdsConnection

AdsConnection Class 9:

DefaultValueEncoding

Gets the default value encoding.

AdsConnection Class 10:

Disposed

Gets a value indicating whether this AdsConnection is disposed.

AdsConnection Class 11:

Id

Gets the AdsConnection identifier.

AdsConnection Class 12:

IsActive

Gets a value indicating whether communication is in active state

AdsConnection Class 13:

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.

AdsConnection Class 14:

IsLocal

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

AdsConnection Class 15:

IsLost

Gets a value indicating whether the communication is in lost / open state

AdsConnection Class 16:

IsReconnecting

Gets a value indicating whether communication is ready for reconnecting

AdsConnection Class 17:

Name

Gets the name of this AdsConnection.

AdsConnection Class 18:

Session

Gets the Session object of the AdsConnection object.

AdsConnection Class 19:

State

Gets the current ConnectionState

AdsConnection Class 20:

Timeout

Gets the timeout (in milliseconds)

AdsConnection Class 21:

TotalConnectionLosses

Gets the connection lost count.

AdsConnection Class 22:

TotalResurrectingTries

Gets the number of tries to resurrect the AdsConnection.

AdsConnection Class 23:

TotalResurrections

Gets the number of succeeded connection resurrections.

Methods

 

Name

Description

AdsConnection Class 24:

AddDeviceNotification(String, Int32, NotificationSettings, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 25:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 26:

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

Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 27:

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.

AdsConnection Class 28:

AddDeviceNotificationEx(String, NotificationSettings, Object, Type)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.

AdsConnection Class 29:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.

AdsConnection Class 30:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.

AdsConnection Class 31:

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.

AdsConnection Class 32:

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.

AdsConnection Class 33:

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.

AdsConnection Class 34:

CleanupSymbolTable

Clears the internal symbol cache.

AdsConnection Class 35:

Close

Closes the AdsConnection

AdsConnection Class 36:

Connect

(Re)Connects the IConnection when disconnected.

AdsConnection Class 37:

CreateVariableHandle

Generates a unique handle for an ADS variable.

AdsConnection Class 38:

CreateVariableHandleAsync

Determines the Symbol handle by its instance path asynchronously.

AdsConnection Class 39:

DeleteDeviceNotification

Deletes an existing notification.

AdsConnection Class 40:

DeleteDeviceNotificationAsync

Deletes a registered notification asynchronously.

AdsConnection Class 41:

DeleteVariableHandle

Releases the handle of a ADS variable again.

AdsConnection Class 42:

DeleteVariableHandleAsync

Releases the handle of a ADS variable again (asynchronously)

AdsConnection Class 43:

Disconnect

Disconnects this IConnection.

AdsConnection Class 44:

Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

AdsConnection Class 45:

Equals

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

AdsConnection Class 46:

GetHashCode

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

AdsConnection Class 47:

GetType

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

AdsConnection Class 48:

AdsConnection Class 49:

InvokeRpcMethod(String, String, .Object.)

Invokes the specified RPC Method

AdsConnection Class 50:

AdsConnection Class 51:

InvokeRpcMethod(String, String, .Object., .Object..)

Invokes the specified RPC Method

AdsConnection Class 52:

AdsConnection Class 53:

InvokeRpcMethod(String, String, .Object., AnyTypeSpecifier)

Invokes the specified RPC Method

AdsConnection Class 54:

AdsConnection Class 55:

InvokeRpcMethod(String, String, .Object., .AnyTypeSpecifier., AnyTypeSpecifier, .Object..)

Invokes the specified RPC Method

AdsConnection Class 56:

AdsConnection Class 57:

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

Invokes the specified RPC Method asynchronously

AdsConnection Class 58:

AdsConnection Class 59:

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

Invokes the specified RPC Method asynchronously

AdsConnection Class 60:

AdsConnection Class 61:

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

Invokes the specified RPC Method asynchronously

AdsConnection Class 62:

Read(UInt32, Memory.Byte.)

Reads the value from the symbol that is represented by the handle.

AdsConnection Class 63:

Read(UInt32, UInt32, Memory.Byte.)

Reads data synchronously from an ADS device and writes it to the given readBuffer

AdsConnection Class 64:

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

Reads data synchronously from an ADS device and writes it to the given stream.

AdsConnection Class 65:

ReadAny(UInt32, Type)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 66:

ReadAny(UInt32, Type, .Int32.)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 67:

ReadAny(UInt32, UInt32, Type)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 68:

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

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 69:

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

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 70:

ReadAny.T.(UInt32)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 71:

ReadAny.T.(UInt32, .Int32.)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 72:

ReadAny.T.(UInt32, UInt32)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 73:

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

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 74:

ReadAnyAsync(UInt32, Type, CancellationToken)

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 75:

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

Reads data synchronously from an ADS device and writes it to an object.

AdsConnection Class 76:

ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.

AdsConnection Class 77:

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

Reads data asynchronously from an ADS device and writes it to an object.

AdsConnection Class 78:

ReadAnyAsync.T.(UInt32, CancellationToken)

Reads data synchronously from an ADS device.

AdsConnection Class 79:

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

Reads data asynchronously from an ADS device and writes it to an object.

AdsConnection Class 80:

ReadAnyAsync.T.(UInt32, UInt32, CancellationToken)

Reads data asynchronously from an ADS device and writes it to an object.

AdsConnection Class 81:

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

Reads data asynchronously from an ADS device and writes it to an object.

AdsConnection Class 82:

ReadAnyString(UInt32, Int32, Encoding)

Reads a string from the specified symbol/variable.

AdsConnection Class 83:

ReadAnyString(UInt32, UInt32, Int32, Encoding)

Reads as string from a specified address.

AdsConnection Class 84:

ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)

Reads a string asynchronously from the specified symbol/variable

AdsConnection Class 85:

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

read any string as an asynchronous operation.

AdsConnection Class 86:

ReadAsync(UInt32, Memory.Byte., CancellationToken)

Reads the value data of the symbol asynchronously into the readBuffer.

AdsConnection Class 87:

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

Reads the data asynchronously from specified IndexGroup/IndexOffset

AdsConnection Class 88:

ReadDataType

Call this method to obtain information about the specified data type.

AdsConnection Class 89:

ReadDataTypeAsync

read data type as an asynchronous operation.

AdsConnection Class 90:

ReadDeviceInfo

Reads the identification and version number of an ADS server.

AdsConnection Class 91:

ReadDeviceInfoAsync

Reads the identification and version number of an ADS server.

AdsConnection Class 92:

ReadState.

Reads the ADS status and the device status from an ADS server.

AdsConnection Class 93:

ReadState(Int32)

Reads the ADS status and the device status from an ADS server.

AdsConnection Class 94:

ReadStateAsync

Read the ADS State asynchronously

AdsConnection Class 95:

ReadSymbol

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

AdsConnection Class 96:

ReadSymbolAsync

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

AdsConnection Class 97:

ReadValue(ISymbol)

Reads the value of a symbol and returns it as an object. Strings and all primitive datatypes(UInt32, Int32, Bool etc.) are supported. Arrays and structures cannot be read.

AdsConnection Class 98:

ReadValue(String, Type)

Reads the value of a symbol and returns the value as object. The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 99:

ReadValue.T.(ISymbol)

Reads the value of a symbol and returns it as an object.

AdsConnection Class 100:

ReadValue.T.(String)

Reads the value of a symbol and returns the value. The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 101:

ReadValueAsync(ISymbol, CancellationToken)

Reads the value of a symbol and returns it as an object. Strings and all primitive datatypes (UInt32, Int32, Bool etc.) are supported. Arrays and structures cannot be read.

AdsConnection Class 102:

ReadValueAsync(String, Type, CancellationToken)

Reads the value of a symbol asynchronously.

AdsConnection Class 103:

ReadValueAsync.T.(ISymbol, CancellationToken)

Reads the value of a symbol asynchronously and returns it as an object.

AdsConnection Class 104:

ReadValueAsync.T.(String, CancellationToken)

Reads the value of a symbol asynchronously.

AdsConnection Class 105:

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

Writes data synchronously to an ADS device and then Reads data from that target.

AdsConnection Class 106:

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

Writes data synchronously to an ADS device and then Reads data from this device into the readBuffer

AdsConnection Class 107:

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

Writes data synchronously to an ADS device and then Reads data from this device.

AdsConnection Class 108:

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

ReadWrites value data asynchronously to/from the symbol represented by the variableHandle.

AdsConnection Class 109:

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

Read/Writes data asynchronously to/from the specified writeBuffer, readBuffer

AdsConnection Class 110:

RegisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.

AdsConnection Class 111:

RegisterSymbolVersionChanged

Registers the symbol version changed.

AdsConnection Class 112:

RegisterSymbolVersionChangedAsync

Registers the symbol version changed asynchronously.

AdsConnection Class 113:

ToString

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

AdsConnection Class 114:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 115:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 116:

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

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

AdsConnection Class 117:

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.

AdsConnection Class 118:

TryCreateVariableHandle

Read (determine) the Symbol handle by its name/path

AdsConnection Class 119:

TryDeleteDeviceNotification

Deletes a registered notification.

AdsConnection Class 120:

TryDeleteVariableHandle

Releases the specified symbol/variable handle synchronously.

AdsConnection Class 121:

AdsConnection Class 122:

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

Invokes the specified RPC Method

AdsConnection Class 123:

AdsConnection Class 124:

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

Invokes the specified RPC Method

AdsConnection Class 125:

AdsConnection Class 126:

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

Invokes the rpc method.

AdsConnection Class 127:

AdsConnection Class 128:

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

Invokes the rpc method.

AdsConnection Class 129:

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

Reads the value synchronously data of the symbol, that is represented by the variable handle into the readBuffer.

AdsConnection Class 130:

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

Reads data synchronously from an ADS device and writes it to the given stream.

AdsConnection Class 131:

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

Reads data synchronously from an ADS device and writes it to the given stream.

AdsConnection Class 132:

TryReadDataType

Call this method to obtain information about the specified data type.

AdsConnection Class 133:

TryReadState(StateInfo.)

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.

AdsConnection Class 134:

TryReadState(Int32, StateInfo.)

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.

AdsConnection Class 135:

TryReadSymbol

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

AdsConnection Class 136:

TryReadValue(ISymbol, Object.)

Reads the value of a symbol and returns the value as object. The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 137:

TryReadValue(String, Type, Object.)

Reads the value of a symbol and returns the value as object.

AdsConnection Class 138:

TryReadValue.T.(ISymbol, T.)

Reads the value of a symbol and returns it as an object.

AdsConnection Class 139:

TryReadValue.T.(String, T.)

Reads the value of a symbol and returns the value as object.

AdsConnection Class 140:

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

ReadWrites value data synchronously to/from the symbol represented by the variableHandle.

AdsConnection Class 141:

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

Writes data synchronously to an ADS device and reads data from that device.

AdsConnection Class 142:

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

Writes data synchronously to an ADS device and then Reads data from this device.

AdsConnection Class 143:

TryWrite(UInt32, ReadOnlyMemory.Byte.)

Writes the value data synchronously that is represented in the writeBuffer to the symbol with the specified variableHandle.

AdsConnection Class 144:

TryWrite(UInt32, UInt32, ReadOnlyMemory.Byte.)

Writes data synchronously to an ADS device.

AdsConnection Class 145:

TryWrite(UInt32, UInt32, ReadOnlyMemory.Byte., Int32)

Writes data synchronously to an ADS device.

AdsConnection Class 146:

TryWriteControl(StateInfo)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 147:

TryWriteControl(StateInfo, Int32)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 148:

TryWriteControl(StateInfo, ReadOnlyMemory.Byte.)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 149:

TryWriteControl(StateInfo, ReadOnlyMemory.Byte., Int32)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 150:

TryWriteValue(ISymbol, Object)

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

AdsConnection Class 151:

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.

AdsConnection Class 152:

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.

AdsConnection Class 153:

TryWriteValue.T.(String, T)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 154:

UnregisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.

AdsConnection Class 155:

UnregisterSymbolVersionChanged

Unregisters the symbol version changed.

AdsConnection Class 156:

UnregisterSymbolVersionChangedAsync

Unregisters the symbol version changed asynchronous.

AdsConnection Class 157:

Write(UInt32, ReadOnlyMemory.Byte.)

Writes data synchronously to an ADS device.

AdsConnection Class 158:

Write(UInt32, UInt32)

Trigger Client Method/Command.

AdsConnection Class 159:

Write(UInt32, UInt32, Int32)

Trigger Client Method/Command.

AdsConnection Class 160:

Write(UInt32, UInt32, ReadOnlyMemory.Byte.)

Writes data synchronously to an ADS device.

AdsConnection Class 161:

Write(UInt32, UInt32, ReadOnlyMemory.Byte., Int32)

Writes data synchronously to an ADS device.

AdsConnection Class 162:

WriteAny(UInt32, Object)

Writes an object synchronously to an ADS device.

AdsConnection Class 163:

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.

AdsConnection Class 164:

WriteAny(UInt32, UInt32, Object)

Writes an object synchronously to an ADS device.

AdsConnection Class 165:

WriteAny(UInt32, 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.

AdsConnection Class 166:

WriteAny(UInt32, UInt32, Object, .Int32., 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.

AdsConnection Class 167:

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.

AdsConnection Class 168:

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.

AdsConnection Class 169:

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.

AdsConnection Class 170:

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

write any as an asynchronous operation.

AdsConnection Class 171:

WriteAnyStringAsync(String, String, Int32, Encoding, CancellationToken)

write any string as an asynchronous operation.

AdsConnection Class 172:

WriteAnyStringAsync(UInt32, String, Int32, Encoding, CancellationToken)

write any string as an asynchronous operation.

AdsConnection Class 173:

WriteAsync(UInt32, ReadOnlyMemory.Byte., CancellationToken)

Writes the value data asynchronously that is represented by the writeBuffer to the symbol specified by the variableHandle.

AdsConnection Class 174:

WriteAsync(UInt32, UInt32, CancellationToken)

Triggers a write call at the specified IndexGroup/IndexOffset asynchronously.

AdsConnection Class 175:

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

Writes the data / Value asynchronously into the specified writeBuffer.

AdsConnection Class 176:

WriteControl(StateInfo)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 177:

WriteControl(StateInfo, Int32)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 178:

WriteControl(StateInfo, ReadOnlyMemory.Byte.)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 179:

WriteControl(StateInfo, ReadOnlyMemory.Byte., Int32)

Changes the ADS status and the device status of an ADS server.

AdsConnection Class 180:

WriteControlAsync(AdsState, UInt16, CancellationToken)

Changes the ADS status and device status of the ADS server asynchronously.

AdsConnection Class 181:

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

Writes the AdsState and device state to the ADS device.

AdsConnection Class 182:

WriteSymbolAsync

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 183:

WriteValue(ISymbol, Object)

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

AdsConnection Class 184:

WriteValue(String, Object)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 185:

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.

AdsConnection Class 186:

WriteValue.T.(String, T)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

AdsConnection Class 187:

WriteValueAsync(ISymbol, Object, CancellationToken)

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

AdsConnection Class 188:

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.

AdsConnection Class 189:

WriteValueAsync.T.(String, T, CancellationToken)

Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

Events

 

Name

Description

AdsConnection Class 190:

AdsConnection Class 191:

AdsNotification

Occurs when the ADS device sends a notification to the client.

AdsConnection Class 192:

AdsNotificationError

Occurs when a exception has occurred during notification management.

AdsConnection Class 193:

AdsConnection Class 194:

AdsNotificationEx

Occurs when the ADS devices sends a notification to the client.

AdsConnection Class 195:

AdsStateChanged

Occurs when ADS State has been changed.

AdsConnection Class 196:

AdsConnection Class 197:

AdsSumNotification

Occurs when Notifications are send (bundled notifications)

AdsConnection Class 198:

AdsSymbolVersionChanged

Occurs when the symbol version has been changed.

AdsConnection Class 199:

AdsConnection Class 200:

ConnectionStateChanged

Occurs when connection status of the AdsConnection has been changed.

AdsConnection Class 201:

RouterStateChanged

(Local) Router state changed event.

Extension Methods

 

Name

Description

AdsConnection Class 202:

PollAdsState(IObservable.Unit.)

Overloaded.

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

AdsConnection Class 203:

AdsConnection Class 204:

PollAdsState(IObservable.Unit.)

Overloaded.

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

AdsConnection Class 205:

AdsConnection Class 206:

PollAdsState(TimeSpan)

Overloaded.

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

AdsConnection Class 207:

AdsConnection Class 208:

PollAdsState(TimeSpan)

Overloaded.

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

AdsConnection Class 209:

PollAdsState2(IObservable.Unit.)

Overloaded.

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

AdsConnection Class 210:

AdsConnection Class 211:

PollAdsState2(TimeSpan)

Overloaded.

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

AdsConnection Class 212:

PollAdsState2Async(IObservable.Unit., CancellationToken)

Overloaded.

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

AdsConnection Class 213:

PollAdsState2Async(TimeSpan, CancellationToken)

Overloaded.

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

AdsConnection Class 214:

AdsConnection Class 215:

PollAdsStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

AdsConnection Class 216:

AdsConnection Class 217:

PollAdsStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

AdsConnection Class 218:

AdsConnection Class 219:

PollAdsStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

AdsConnection Class 220:

AdsConnection Class 221:

PollAdsStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

AdsConnection Class 222:

PollDeviceState(IObservable.Unit.)

Overloaded.

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

AdsConnection Class 223:

AdsConnection Class 224:

PollDeviceState(TimeSpan)

Overloaded.

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

AdsConnection Class 225:

AdsConnection Class 226:

PollDeviceStateAsync(IObservable.Unit., CancellationToken)

Overloaded.

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

AdsConnection Class 227:

AdsConnection Class 228:

PollDeviceStateAsync(TimeSpan, CancellationToken)

Overloaded.

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

AdsConnection Class 229:

PollSystemServiceState

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

AdsConnection Class 230:

PollSystemServiceStateAsync

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

AdsConnection Class 231:

PollValues(ISymbol, Type, IObservable.Unit.)

Overloaded.

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

AdsConnection Class 232:

PollValues(ISymbol, Type, TimeSpan)

Overloaded.

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

AdsConnection Class 233:

PollValues(String, Type, IObservable.Unit.)

Overloaded.

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

AdsConnection Class 234:

PollValues(String, Type, TimeSpan)

Overloaded.

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

AdsConnection Class 235:

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

Overloaded.

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

AdsConnection Class 236:

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

AdsConnection Class 237:

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

AdsConnection Class 238:

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

Overloaded.

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

AdsConnection Class 239:

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

AdsConnection Class 240:

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

AdsConnection Class 241:

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

AdsConnection Class 242:

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

AdsConnection Class 243:

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

AdsConnection Class 244:

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

AdsConnection Class 245:

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

Overloaded.

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

AdsConnection Class 246:

PollValues.T.(ISymbol, TimeSpan)

Overloaded.

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

AdsConnection Class 247:

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

Overloaded.

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

AdsConnection Class 248:

PollValues.T.(String, TimeSpan)

Overloaded.

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

AdsConnection Class 249:

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

AdsConnection Class 250:

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

AdsConnection Class 251:

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

Overloaded.

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

AdsConnection Class 252:

AdsConnection Class 253:

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

Overloaded.

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

AdsConnection Class 254:

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

AdsConnection Class 255:

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

AdsConnection Class 256:

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

Overloaded.

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

AdsConnection Class 257:

AdsConnection Class 258:

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

Overloaded.

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

AdsConnection Class 259:

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

AdsConnection Class 260:

AdsConnection Class 261:

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

AdsConnection Class 262:

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

AdsConnection Class 263:

AdsConnection Class 264:

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

AdsConnection Class 265:

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

Overloaded.

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

AdsConnection Class 266:

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

Overloaded.

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

AdsConnection Class 267:

ReadSysServState

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

AdsConnection Class 268:

ReadSysServStateAsync

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

AdsConnection Class 269:

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

Overloaded.

Ads Read with fallback. (Defined by AdsClientExtensions.)

AdsConnection Class 270:

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

Overloaded.

Ads Read with Fallback. (Defined by AdsClientExtensions.)

AdsConnection Class 271:

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

Overloaded.

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

AdsConnection Class 272:

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

Overloaded.

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

AdsConnection Class 273:

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

Overloaded.

Repeated AdsRead. (Defined by AdsClientExtensions.)

AdsConnection Class 274:

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

Overloaded.

Repeated AdsRead. (Defined by AdsClientExtensions.)

AdsConnection Class 275:

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

Overloaded.

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

AdsConnection Class 276:

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

Overloaded.

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

AdsConnection Class 277:

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

AdsConnection Class 278:

SetAdsState

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

AdsConnection Class 279:

SetAdsStateAsync

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

AdsConnection Class 280:

WaitUntilRestarted

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

AdsConnection Class 281:

WaitUntilRestartedAsync

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

AdsConnection Class 282:

AdsConnection Class 283:

WhenAdsStateChanges

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

AdsConnection Class 284:

WhenNotification(ISymbol)

Overloaded.

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

AdsConnection Class 285:

AdsConnection Class 286:

WhenNotification(ISymbolCollection)

Overloaded.

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

AdsConnection Class 287:

AdsConnection Class 288:

WhenNotification(IList.ISymbol., NotificationSettings)

Overloaded.

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

AdsConnection Class 289:

WhenNotification(ISymbol, NotificationSettings)

Overloaded.

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

AdsConnection Class 290:

AdsConnection Class 291:

WhenNotification(String, Type, NotificationSettings)

Overloaded.

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

AdsConnection Class 292:

AdsConnection Class 293:

WhenNotification.T.(String, NotificationSettings)

Overloaded.

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

AdsConnection Class 294:

WhenSymbolVersionChanges.

Overloaded.

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

AdsConnection Class 295:

WhenSymbolVersionChanges(IScheduler)

Overloaded.

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

AdsConnection Class 296:

AdsConnection Class 297:

WhenValueChanged

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

AdsConnection Class 298:

AdsConnection Class 299:

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

Overloaded.

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

AdsConnection Class 300:

AdsConnection Class 301:

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 class represents an ADS Point-to-Point Connection between client and server. It is established by using the Connect method of the AdsSession object. An ADS Connection can have different ConnectionStates, which represent the state of the logical ADS connection.

Reference

TwinCAT.Ads Namespace

TwinCAT.Ads.AdsSession

TwinCAT.Ads.IAdsConnection

System.IDisposable