Skip to content

    TSimpleIPCServer.PeekMessage

    Check if a client message is available.

    Declaration

    Source position: simpleipc.pp line 214

    public 
function TSimpleIPCServer.PeekMessage(Timeout: Integer; 
                                     DoReadMessage: Boolean) : Boolean;

    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

    Name Description
    ReadMessage Read message from the queue.