TcAdsClient.TryReadState Method

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

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

Syntax

C#

public AdsErrorCode TryReadState(
    out StateInfo stateInfo
)

VB

Public Function TryReadState ( 
    <OutAttribute> ByRef stateInfo As StateInfo
) As AdsErrorCode

Parameters

stateInfo

Type: TwinCAT.Ads.StateInfo.
The ADS statue and device status.

Return Value

Type: AdsErrorCode
AdsErrorCode of the ads read state call. Check for AdsErrorCode.NoError to see if call was successfull.

Reference

TcAdsClient Class

TwinCAT.Ads Namespace