Sign in Join
FPDoc Onlineexperiment

TIPCServerComm.PeekMessage function

Member of TIPCServerCommpublicIn unit SimpleIPC

See if a message is available.

Declaration

pascal
function PeekMessage(Timeout: Integer): Boolean; virtual; abstract

Arguments

Timeout

Number of milliseconds to wait for a message.

Function result

True if a message was available.

Description

PeekMessage can be used to see if a message is available: it returns True if a message is available. It will wait maximum TimeOut milliseconds for a message to arrive. If no message was available after this time, it will return False.

If a message was available, it can be read with the ReadMessage call.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.