AdsConnection Class

ADS Connection class

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.AdsConnection

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

Syntax

C#

public sealed class AdsConnection : IAdsConnection, 
	IConnection, IConnectionStateProvider, IAdsNotifications, IAdsSymbolicAccess, IAdsAnyAccess, 
	IAdsHandle, 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:

ChannelPortType

Gets the channel port type.

AdsConnection Class 5:

ChannelProtocol

Gets the channel protocol.

AdsConnection Class 6:

ClientAddress

Get the AmsAddress of the ADS client.

AdsConnection Class 7:

Configuration

Gets the configuration.

AdsConnection Class 8:

ConnectionEstablishedAt

Gets the UTC time when the Connection was originally established.

AdsConnection Class 9:

ConnectionLostTime

Gets the connection lost time.

AdsConnection Class 10:

AdsConnection Class 11:

ConnectionState

Gets the current Connection state of the AdsConnection

AdsConnection Class 12:

DefaultValueEncoding

Gets the default value encoding.

AdsConnection Class 13:

Disposed

Gets a value indicating whether this AdsConnection is disposed.

AdsConnection Class 14:

Id

Gets the AdsConnection identifier.

AdsConnection Class 15:

IsActive

Gets a value indicating whether communication is in active state

AdsConnection Class 16:

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

IsLocal

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

AdsConnection Class 18:

IsLost

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

AdsConnection Class 19:

IsReconnecting

Gets a value indicating whether communication is ready for reconnecting

AdsConnection Class 20:

Logger

Gets the connection logger interface.

AdsConnection Class 21:

LoggerFactory

Gets the logger factory.

AdsConnection Class 22:

Name

Gets the name of this AdsConnection.

AdsConnection Class 23:

Session

Gets the Session object of the AdsConnection object.

AdsConnection Class 24:

State

Gets the current ConnectionState

AdsConnection Class 25:

SymbolEncoding

Gets the symbol encoding.

AdsConnection Class 26:

Timeout

Gets the timeout (in milliseconds)

AdsConnection Class 27:

TotalConnectionLosses

Gets the connection lost count.

AdsConnection Class 28:

TotalResurrectingTries

Gets the number of tries to resurrect the AdsConnection.

AdsConnection Class 29:

TotalResurrections

Gets the number of succeeded connection resurrections.

Methods

 

Name

Description

AdsConnection Class 30:

AddDeviceNotification(String, Int32, NotificationSettings, Object)

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

AdsConnection Class 31:

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

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

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

AddDeviceNotificationEx(String, NotificationSettings, Object, Type)

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

AdsConnection Class 35:

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

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

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

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

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

CleanupSymbolTable

Clears the internal symbol cache.

AdsConnection Class 41:

Close

Closes the AdsConnection

AdsConnection Class 42:

Connect

(Re)Connects the IConnection when disconnected.

AdsConnection Class 43:

ConnectAndWaitAsync

Connects the and wait asynchronous.

AdsConnection Class 44:

ConnectAsync

Connect as an asynchronous operation.

AdsConnection Class 45:

CreateVariableHandle

Generates a unique handle for an ADS variable.

AdsConnection Class 46:

CreateVariableHandleAsync

Determines the Symbol handle by its instance path asynchronously.

AdsConnection Class 47:

DeleteDeviceNotification

Deletes an existing notification.

AdsConnection Class 48:

DeleteDeviceNotificationAsync

Deletes a registered notification asynchronously.

AdsConnection Class 49:

DeleteVariableHandle

Releases the handle of a ADS variable again.

AdsConnection Class 50:

DeleteVariableHandleAsync

Releases the handle of a ADS variable again (asynchronously)

AdsConnection Class 51:

Disconnect

Disconnects this IConnection.

AdsConnection Class 52:

DisconnectAsync

Disconnects this IConnection.

AdsConnection Class 53:

Dispose

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

AdsConnection Class 54:

Equals

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

AdsConnection Class 55:

GetHashCode

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

AdsConnection Class 56:

GetType

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

AdsConnection Class 57:

AdsConnection Class 58:

InvokeRpcMethod(String, String, Object[])

Invokes the specified RPC Method

AdsConnection Class 59:

AdsConnection Class 60:

InvokeRpcMethod(String, String, Object[], Object[])

Invokes the specified RPC Method

AdsConnection Class 61:

AdsConnection Class 62:

InvokeRpcMethod(String, String, Object[], AnyTypeSpecifier)

Invokes the specified RPC Method

AdsConnection Class 63:

AdsConnection Class 64:

InvokeRpcMethod(String, String, Object[], AnyTypeSpecifier[], AnyTypeSpecifier, Object[])

Invokes the specified RPC Method

AdsConnection Class 65:

AdsConnection Class 66:

InvokeRpcMethodAsync(String, String, Object[], CancellationToken)

Invokes the specified RPC Method asynchronously

AdsConnection Class 67:

AdsConnection Class 68:

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

Invokes the specified RPC Method asynchronously

AdsConnection Class 69:

AdsConnection Class 70:

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

Invokes the specified RPC Method asynchronously

AdsConnection Class 71:

ReadAny(String, Type)

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

AdsConnection Class 72:

ReadAny(UInt32, Type)

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

AdsConnection Class 73:

ReadAny(String, Type, Int32[])

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

AdsConnection Class 74:

ReadAny(UInt32, Type, Int32[])

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

AdsConnection Class 75:

ReadAny(UInt32, UInt32, Type)

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

AdsConnection Class 76:

ReadAny(UInt32, UInt32, Type, Int32[])

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

AdsConnection Class 77:

ReadAny(UInt32, UInt32, Type, Int32[], Int32)

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

AdsConnection Class 78:

ReadAny<T>(String)

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

AdsConnection Class 79:

ReadAny<T>(UInt32)

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

AdsConnection Class 80:

ReadAny<T>(String, Int32[])

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

AdsConnection Class 81:

ReadAny<T>(UInt32, Int32[])

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

AdsConnection Class 82:

ReadAny<T>(UInt32, UInt32)

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

AdsConnection Class 83:

ReadAny<T>(UInt32, UInt32, Int32[])

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

AdsConnection Class 84:

ReadAnyAsResult<T>(String)

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

AdsConnection Class 85:

ReadAnyAsResult<T>(String, Int32[])

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

AdsConnection Class 86:

ReadAnyAsync(String, Type, CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 87:

ReadAnyAsync(UInt32, Type, CancellationToken)

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

AdsConnection Class 88:

ReadAnyAsync(String, Type, Int32[], CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 89:

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

Read any as an asynchronous operation.

AdsConnection Class 90:

ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)

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

AdsConnection Class 91:

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

Read any as an asynchronous operation.

AdsConnection Class 92:

ReadAnyAsync<T>(String, CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 93:

ReadAnyAsync<T>(UInt32, CancellationToken)

Reads data synchronously from an ADS device.

AdsConnection Class 94:

ReadAnyAsync<T>(String, Int32[], CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 95:

ReadAnyAsync<T>(UInt32, Int32[], CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 96:

ReadAnyAsync<T>(UInt32, UInt32, CancellationToken)

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

AdsConnection Class 97:

ReadAnyAsync<T>(UInt32, UInt32, Int32[], CancellationToken)

Read any as an asynchronous operation.

AdsConnection Class 98:

ReadAnyString(String, Int32, Encoding)

Reads any string.

AdsConnection Class 99:

ReadAnyString(UInt32, Int32, Encoding)

Reads a string from the specified symbol/variable.

AdsConnection Class 100:

ReadAnyString(UInt32, UInt32, Int32, Encoding)

Reads as string from a specified address.

AdsConnection Class 101:

ReadAnyStringAsync(String, Int32, Encoding, CancellationToken)

Read any string as an asynchronous operation.

AdsConnection Class 102:

ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)

Reads a string asynchronously from the specified symbol/variable

AdsConnection Class 103:

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

read any string as an asynchronous operation.

AdsConnection Class 104:

ReadAsResult(UInt32, Int32)

Reads the value synchronously data of the symbol, that is represented by the variable handle./>.

AdsConnection Class 105:

ReadAsResult(UInt32, UInt32, Int32)

Reads data synchronously from an ADS device />

AdsConnection Class 106:

ReadAsResult(UInt32, UInt32, Int32, Int32)

Reads data synchronously from an ADS device.

AdsConnection Class 107:

ReadDataType

Reads/Determines the DataType Inforrmation with the specifed name.

AdsConnection Class 108:

ReadDataTypeAsync

Reads/Determines the DataType of the specified type as an asynchronous operation.

AdsConnection Class 109:

ReadDeviceInfo

Reads the identification and version number of an ADS server.

AdsConnection Class 110:

ReadDeviceInfoAsync

Reads the identification and version number of an ADS server.

AdsConnection Class 111:

ReadState()

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

AdsConnection Class 112:

ReadState(Int32)

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

AdsConnection Class 113:

ReadStateAsync

Read state as an asynchronous operation.

AdsConnection Class 114:

ReadSymbol

Reads the symbol.

AdsConnection Class 115:

ReadSymbolAsync

Read symbol as an asynchronous operation.

AdsConnection Class 116:

ReadValue(ISymbol)

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

AdsConnection Class 117:

ReadValue(String)

Reads the value of a symbol specified with its instance path and returns the value as boxed object.

AdsConnection Class 118:

ReadValue(String, Type)

Reads the value of a symbol specified with its instance path and returns the value as object of the specified type.

AdsConnection Class 119:

ReadValue<T>(ISymbol)

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

AdsConnection Class 120:

ReadValue<T>(String)

Reads the value.

AdsConnection Class 121:

ReadValueAsync(ISymbol, CancellationToken)

Read value as an asynchronous operation.

AdsConnection Class 122:

ReadValueAsync(String, Type, CancellationToken)

Read value as an asynchronous operation.

AdsConnection Class 123:

ReadValueAsync<T>(ISymbol, CancellationToken)

Read value as an asynchronous operation.

AdsConnection Class 124:

ReadValueAsync<T>(String, CancellationToken)

Read value as an asynchronous operation.

AdsConnection Class 125:

ReadWriteAsResult(UInt32, UInt32, Int32, ReadOnlyMemory<Byte>)

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

AdsConnection Class 126:

ReadWriteAsResult(UInt32, UInt32, Int32, ReadOnlyMemory<Byte>, Int32)

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

AdsConnection Class 127:

RegisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.

AdsConnection Class 128:

RegisterSymbolVersionChanged

Registers the symbol version changed event (synchronously)

AdsConnection Class 129:

RegisterSymbolVersionChangedAsync

Registers the symbol version changed asynchronously.

AdsConnection Class 130:

ToString

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

AdsConnection Class 131:

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

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

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

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

TryCreateVariableHandle

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

AdsConnection Class 136:

TryDeleteDeviceNotification

Deletes a registered notification.

AdsConnection Class 137:

TryDeleteVariableHandle

Releases the specified symbol/variable handle synchronously.

AdsConnection Class 138:

AdsConnection Class 139:

TryInvokeRpcMethod(String, String, Object[], Object)

Invokes the specified RPC Method

AdsConnection Class 140:

AdsConnection Class 141:

TryInvokeRpcMethod(String, String, Object[], Object[], Object)

Invokes the specified RPC Method

AdsConnection Class 142:

AdsConnection Class 143:

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

Invokes the rpc method.

AdsConnection Class 144:

AdsConnection Class 145:

TryInvokeRpcMethod(String, String, Object[], AnyTypeSpecifier[], AnyTypeSpecifier, Object[], Object)

Invokes the rpc method.

AdsConnection Class 146:

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

TryRead(UInt32, UInt32, Memory<Byte>, Int32, Int32)

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

AdsConnection Class 148:

TryReadDataType

Tries to Read/Determine the DataType of the specified type.

AdsConnection Class 149:

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

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

TryReadSymbol

Tries to read the symbol information object specified by the instance path.

AdsConnection Class 152:

TryReadValue(ISymbol, Object)

Tries to read the value of a symbol and returns the value as boxed object.

AdsConnection Class 153:

TryReadValue(String, Type, Object)

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

AdsConnection Class 154:

TryReadValue<T>(ISymbol, T)

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

AdsConnection Class 155:

TryReadValue<T>(String, T)

Tries to reads the value of a symbol specified with instance path and returns the typed value.

AdsConnection Class 156:

TryWrite(UInt32, ReadOnlyMemory<Byte>)

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

AdsConnection Class 157:

TryWrite(UInt32, UInt32, ReadOnlyMemory<Byte>)

Writes data synchronously to an ADS device.

AdsConnection Class 158:

TryWrite(UInt32, UInt32, ReadOnlyMemory<Byte>, Int32)

Writes data synchronously to an ADS device.

AdsConnection Class 159:

TryWriteControl(StateInfo)

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

AdsConnection Class 160:

TryWriteControl(StateInfo, Int32)

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

AdsConnection Class 161:

TryWriteControl(StateInfo, ReadOnlyMemory<Byte>)

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

AdsConnection Class 162:

TryWriteControl(StateInfo, ReadOnlyMemory<Byte>, Int32)

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

AdsConnection Class 163:

TryWriteValue(ISymbol, Object)

Tries to write a (boxed) value to the symbol

AdsConnection Class 164:

TryWriteValue(String, Object)

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

AdsConnection Class 165:

TryWriteValue<T>(ISymbol, T)

Tries to write a value to the symbol.

AdsConnection Class 166:

TryWriteValue<T>(String, T)

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

AdsConnection Class 167:

UnregisterAdsStateChangedAsync

Registers for AdsStateChanged events as an asynchronous operation.

AdsConnection Class 168:

UnregisterSymbolVersionChanged

Unregisters the symbol version changed event (synchronously)

AdsConnection Class 169:

UnregisterSymbolVersionChangedAsync

Unregisters the symbol version changed asynchronously.

AdsConnection Class 170:

Write(UInt32, ReadOnlyMemory<Byte>)

Writes data synchronously to an ADS device.

AdsConnection Class 171:

Write(UInt32, UInt32)

Sends a 'Write' request to the ADS device at the specified address.

AdsConnection Class 172:

Write(UInt32, UInt32, Int32)

Trigger Client Method/Command.

AdsConnection Class 173:

Write(UInt32, UInt32, ReadOnlyMemory<Byte>)

Writes data synchronously to an ADS device.

AdsConnection Class 174:

Write(UInt32, UInt32, ReadOnlyMemory<Byte>, Int32)

Writes data synchronously to an ADS device.

AdsConnection Class 175:

WriteAny(UInt32, Object)

Writes an object synchronously to an ADS device.

AdsConnection Class 176:

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

WriteAny(UInt32, UInt32, Object)

Writes an object synchronously to an ADS device.

AdsConnection Class 178:

WriteAny(UInt32, UInt32, Object, Int32[])

Writes an object synchronously to an ADS device.

AdsConnection Class 179:

WriteAny(UInt32, UInt32, Object, Int32[], Int32)

Writes an object synchronously to an ADS device.

AdsConnection Class 180:

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

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

Write any as an asynchronous operation.

AdsConnection Class 182:

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

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

Write any as an asynchronous operation.

AdsConnection Class 184:

WriteAnyStringAsync

write any string as an asynchronous operation.

AdsConnection Class 185:

WriteAsResult

Writes data synchronously to an ADS device.

AdsConnection Class 186:

WriteAsync(UInt32, ReadOnlyMemory<Byte>, CancellationToken)

Write as an asynchronous operation.

AdsConnection Class 187:

WriteAsync(UInt32, UInt32, CancellationToken)

Write as an asynchronous operation.

AdsConnection Class 188:

WriteAsync(UInt32, UInt32, ReadOnlyMemory<Byte>, CancellationToken)

Write as an asynchronous operation.

AdsConnection Class 189:

WriteControl(StateInfo)

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

AdsConnection Class 190:

WriteControl(StateInfo, Int32)

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

AdsConnection Class 191:

WriteControl(StateInfo, ReadOnlyMemory<Byte>)

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

AdsConnection Class 192:

WriteControl(StateInfo, ReadOnlyMemory<Byte>, Int32)

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

AdsConnection Class 193:

WriteControlAsync(AdsState, UInt16, CancellationToken)

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

AdsConnection Class 194:

WriteControlAsync(AdsState, UInt16, ReadOnlyMemory<Byte>, CancellationToken)

Write control as an asynchronous operation.

AdsConnection Class 195:

WriteSymbolAsync

Write symbol as an asynchronous operation.

AdsConnection Class 196:

WriteValue(ISymbol, Object)

Writes a (boxed) value to the symbol.

AdsConnection Class 197:

WriteValue(String, Object)

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

AdsConnection Class 198:

WriteValue<T>(ISymbol, T)

Writes a (typed) value to the symbol.

AdsConnection Class 199:

WriteValue<T>(String, T)

Writes a typed value to the symbol instance specified by its instance/symbol path.

AdsConnection Class 200:

WriteValueAsync(ISymbol, Object, CancellationToken)

Write value as an asynchronous operation.

AdsConnection Class 201:

WriteValueAsync<T>(ISymbol, T, CancellationToken)

Write value as an asynchronous operation.

AdsConnection Class 202:

WriteValueAsync<T>(String, T, CancellationToken)

Write value as an asynchronous operation.

Events

 

Name

Description

AdsConnection Class 203:

AdsConnection Class 204:

AdsNotification

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

AdsConnection Class 205:

AdsNotificationError

Occurs when a exception has occurred during notification management.

AdsConnection Class 206:

AdsConnection Class 207:

AdsNotificationEx

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

AdsConnection Class 208:

AdsStateChanged

Occurs when ADS State has been changed.

AdsConnection Class 209:

AdsConnection Class 210:

AdsSumNotification

Occurs when Notifications are send (bundled notifications)

AdsConnection Class 211:

AdsSymbolVersionChanged

Occurs when the SymbolVersion table of a TwinCAT PLC System has been changed.

AdsConnection Class 212:

AdsConnection Class 213:

ConnectionStateChanged

Occurs when connection status of the AdsConnection has been changed.

AdsConnection Class 214:

RouterStateChanged

(Local) Router state changed event.

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)

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues<T>

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

PollValues2<T>

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

PollValues2<T>

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)

WhenNotification<T>

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)

WriteValues<T>

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

WriteValues<T>

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.

See Also

Reference

TwinCAT.Ads Namespace AdsSession IAdsConnection IDisposable

Beckhoff Automation GmbH & Co. KG 2001-2026

Further Information
See also