Filter: C++  Pascal  C#  VB.NET  Java  Java ME  ActiveX  DLL 



Messenger.PeekMessage

Messenger     See also    


Returns an incoming message and leaves it in the queue.

Declaration

[C++]
    bool PeekMessage(IPCMessage* Message);

[Pascal]
    function PeekMessage(var Message : TIPCMessage) : boolean;

[VB6]
    Function PeekMessage(Message As IIPCXMessage) As Boolean

[ActiveX]
    HRESULT _stdcall PeekMessage([out] IIPCXMessage ** Message, [out, retval] VARIANT_BOOL * res);

[C#]
    public bool PeekMessage(ref IPCMessage Message);

[VB.NET]
    Public Function PeekMessage(ByRef Message As IPCMessage) As Boolean

[Java]
    public boolean peekMessage(IPCMessage message);

[Java ME]
    public synchronized boolean peekMessage(IPCMessage message);

[DLL]
    long __stdcall IPCMessengerPeekMessage(HIPCMessenger h, IPCMessage* Message, bool* res);

Parameters

  • [DLL]h - handle to the Messenger object that was returned by Create method

  • Message - The structure that PeekMessage places all message data to. See more here
  • res - result of method execution (see Return value for details)

Return value

    True if the message was found and false if there was no incoming message waiting for handing
[DLL]
    Return value is passed via res parameter.
    IPC_OK is always returned.

Description

    Call this method to peek the message from the input queue. This method returns immediately, returning the value that lets you determine whether there was a message in the queue. Upon return the message is NOT marked as being processed and the next call to PeekMessage will return the same message.
    Once the message was processed, the application must call MessageProcessed method to let the Messenger send reply (if necessary) and cleanup internal records.
    This method together with GetMessage and MessageProcessed is an alternative to using Queues.

See also:     Queue class     IPCMessage structure     GetMessage     MessageProcessed