TcAdsClient.ReadSymbol Method (ITcAdsSymbol)

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.

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public Object ReadSymbol(
    ITcAdsSymbol symbol
)

VB

Public Function ReadSymbol ( 
    symbol As ITcAdsSymbol
) As Object

Parameters

symbol

Type: TwinCAT.Ads.ITcAdsSymbol
The symbol that should be read.

Return Value

Type: Object
The value of the symbol as an object.

Exceptions

Exception

Condition

AdsDatatypeNotSupportedException

Thrown when a ADS datatype is not supported.

AdsErrorException

Thrown when the Sync port is not open.

Reference

TcAdsClient Class

ReadSymbol Overload

TwinCAT.Ads Namespace