Sign in Join
FPDoc Onlineexperiment

TSimpleIPCServer.PeekMessage function

Member of TSimpleIPCServerpublicIn unit SimpleIPC

Check if a client message is available.

Declaration

pascal
function PeekMessage(Timeout: Integer; DoReadMessage: Boolean): Boolean

Arguments

Timeout

Number of milliseconds to wait for a message.

DoReadMessage

Should the message be read or not ?

Function result

True if a client message is available.

Description

PeekMessage checks if a message from a client is available. It will return True if a message is available. The call will wait for TimeOut milliseconds for a message to arrive: if after TimeOut milliseconds, no message is available, the function will return False.

If DoReadMessage is True then PeekMessage will read the message. If it is False, it does not read the message. The message should then be read manually with ReadMessage.

See also

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