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


Messenger     See also    

Returns an incoming message with specified destination queue name and leaves it in the queue.


    bool PeekMessageEx(const char* QueueName, IPCMessage* Message);

    function PeekMessageEx(string QueueName, var Message : TIPCMessage) : boolean;

    Function PeekMessageEx(QueueName As String, Message As IIPCXMessage) As Boolean

    HRESULT _stdcall PeekMessageEx([in] BSTR QueueName, [out] IIPCXMessage ** Message, [out, retval] VARIANT_BOOL * res);

    public bool PeekMessageEx(string QueueName, ref IPCMessage Message);

    Public Function PeekMessageEx(QueueName As String, ByRef Message As IPCMessage) As Boolean

    public boolean PeekMessageEx(String queueName, IPCMessage message);

[Java ME]
not available;

    long __stdcall IPCMessengerPeekMessageEx(const char* QueueName, HIPCMessenger h, IPCMessage* Message, bool* res);


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

  • QueueName - The name of the queue, to which the message has arrived
  • Message - The structure that PeekMessageEx 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
    Return value is passed via res parameter.
    IPC_OK is always returned.


    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 PeekMessageEx 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