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



Messenger.GetMessage

Messenger     See also    


Returns next incoming message and removes it from the queue.

Declaration

[C++]
    void GetMessage(IPCMessage* Message);

[Pascal]
    procedure GetMessage(var Message : TIPCMessage);

[VB6]
    Sub GetMessage(Message As IIPCXMessage)

[ActiveX]
    HRESULT _stdcall GetMessage([out] IIPCXMessage ** Message);

[C#]
    public void GetMessage(ref IPCMessage Message)

[VB.NET]
    Public Sub GetMessage(ByRef Message As IPCMessage)

[Java]
    public void getMessage(IPCMessage message);

[Java ME]
    public synchronized void getMessage(IPCMessage message);

[DLL]
    long __stdcall IPCMessengerGetMessage(HIPCMessenger h, IPCMessage* Message);

Parameters

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

  • Message - The record that GetMessage places all message data to. See more here

Return value

[DLL]
    IPC_OK is always returned.

Description

    Call this method to get the message from the input queue. This method returns only when the message is available (if the message is not available, the method doesn't return). Upon return the message is marked as being processed and the next call to GetMessage will return the next 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 PeekMessage and MessageProcessed is an alternative to using Queues.

See also:     Queue class     IPCMessage structure     PeekMessage     MessageProcessed