TCP_Read (FB)ΒΆ

FUNCTION_BLOCK TCP_Read EXTENDS CBM.LTrig

This function block serves to read data from the previously established connection given in hConnection. As long as xEnable is TRUE the handle of the connection is valid. The pointer pData specifies the memory area to write the read data to. szSize defines the max number of bytes to read. When the data was read successfully, xReady is set to TRUE and szCount indicates the actually read number of bytes.

InOut:

Scope

Name

Type

Comment

Inherited from

Input

xEnable

BOOL

TRUE: Action starts
FALSE: Action stops, outputs xDone, xBusy, xError are resetted

LTrig

Output

xDone

BOOL

TRUE: Action successfully completed

LTrig

xBusy

BOOL

TRUE: Function block active

LTrig

xError

BOOL

TRUE: Error occurred, function block aborts action
FALSE: No error

LTrig

Input

hConnection

CAA.HANDLE

szSize

CAA.SIZE

pData

CAA.PVOID

Output

eError

ERROR

xReady

BOOL

szCount

CAA.SIZE