GetCommWindowData

<< Click to Display Table of Contents >>

Navigation:  Reference (Scripting) > Docklight Script Commands - The DL Object > Methods (Advanced) >

GetCommWindowData

Returns the accumulated contents of the communication windows buffer.

NOTE: This method is for special applications. For many standard uses cases, the OnSend / OnReceive event procedures, or the GetReceiveComments method will be the preferred solution.

 

Return Value

 

String

 

Syntax

 

result = DL.GetCommWindowData([representation])

The GetCommWindowData method syntax has these parts:

 

Part

Description

representation

Required. String value to define the window buffer format requested:  "A" = ASCII (default), "H" = Hex, "D" = Decimal or "B" = Binary.

 

Remarks

 

Only a representation enabled in Docklight Options – Communication Window Modes can be used. By default, this is ASCII, HEX and Decimal. If required, load different options using LoadProgramOptions.

The maximum size of the GetCommWindowData buffer is 128000 characters. If more communication data is accumulating without calling GetCommWindowData, the oldest data gets deleted.