IAdsHandleAccess.Read Method (Int32, AdsStream)

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

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

Syntax

C#

int Read(
    int variableHandle,
    AdsStream dataStream
)

VB

Function Read ( 
    variableHandle As Integer,
    dataStream As AdsStream
) As Integer

Parameters

variableHandle

Type: System.Int32
Handle of the ADS variable

dataStream

Type: TwinCAT.Ads.AdsStream
Stream that receives the data.

Return Value

Type: Int32
Number of successfully returned data bytes.

Exceptions

Exception

Condition

AdsErrorException

Thrown when the ADS call fails.

Reference

IAdsHandleAccess Interface

Read Overload

TwinCAT.Ads Namespace