Back to product page

Received method


Called when there is data to be received.

Type

None

Syntax

  • Basic
object.Received Owner, ByteCount
The Received(object,Owner,ByteCount) syntax has these parts:
objectAn expression evaluating to an object of type IwodSSHNotify.
OwnerA wodSSHCom object.
ByteCountAn Integer value. Total number of bytes waiting to be read by your program.

Remarks

This method is called only if you implemented the IwodSSHNotify interface in your application, and the wodSSH.Notification property has received a reference to the instance of your implementation.

The Received notification method will be called each time there is data to be read by your program using the Receive method. The ByteCount argument will hold the maximum number you should use with the Receive method once you decide to read the data. You do not have to call the Receive method immediately.

The Received notification method may be called more than once, even when you did not collect data from previous notification. However, calling Receive will always read all the data, starting from bytes that arrived first. It will not discard ones you didn't Receive.

Platforms

Windows