Back to product page

Received event


Fires when there is data to be received.

Syntax

  • Basic
Private Sub object_Received (ByVal ByteCount, ByRef Handled)
The Received(ByteCount,Handled) syntax has these parts:
ByteCountAn Integer value. Total number of bytes waiting to be read by your program.
HandledA Boolean value. Set to True to make wodTelnetDLX ignore it (and prevent printing in client area).

Remarks

Received event will be fired each time there is data to be read by your program using Receive method. ByteCount argument will hold maximum number you should use with Receive method once you decide to read the data. You do not have to call Receive method immediately. However, Received event will not be fired again until you don't Receive data that is currently held in wodTelnetDLX'es internal buffers.

Handled parameter is like a return value you will send to wodTelnetDLX. If you set it to True, then wodTelnetDLX will ignore all data you have received, and remove it from the queue. If you set it to False (default value), then wodTelnetDLX will show received data inside its client area.

COM object version does not contain Handled parameter in this event - because it does not have GUI screen.

Platforms

Windows