3.2.5.2.10.2 IMessenger::RecallMessage (Opnum 4)

The RecallMessage method retrieves a message from the send queue.

 HRESULT RecallMessage(
   [in] LPGUID lpGuid
 );

lpGuid: A pointer to the identifier of the message to retrieve.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070057

ERROR_INVALID_PARAMETER

A parameter is missing.

After the server receives this message, it MUST verify that lpGuid is not equal to NULL. If parameter validation fails, the server MUST immediately fail the operation and return ERROR_INVALID_PARAMETER (0x80070057).

If parameter validation succeeds, the server MUST perform the following actions:

  • Create an event for synchronization.

  • Get the Destination List from the Sent Message List, and verify that it is not NULL.

  • Find the message in the Sent Message List.

  • Remove the message from the list.

If there are no more active requests, the server MUST hide any existing notifications, destroy the handler object and its corresponding dialog, and free the message object.