IMsgStore::AbortSubmit

The IMsgStore::AbortSubmit method attempts to remove a message from the outgoing queue.

Quick Info

See IMsgStore : IMAPIProp.

AbortSubmit(
  ULONG cbEntryID,       
  LPENTRYID lpEntryID,   
  ULONG ulFlags          
);
 

Parameters

cbEntryID

[in] Count of bytes in the entry identifier pointed to by the lpEntryID parameter.

lpEntryID

[in] Pointer to the entry identifier of the message to remove from the outgoing queue.

ulFlags

Reserved; must be zero.

Return Values

S_OK

The message was successfully removed from the outgoing queue.

MAPI_E_NOT_IN_QUEUE

The message identified by lpEntryID is no longer in the message store's outgoing queue, typically because it has already been sent.

MAPI_E_UNABLE_TO_ABORT

The message identified by lpEntryID is locked by the MAPI spooler, and the operation cannot be aborted.

Remarks

The IMsgStore::AbortSubmit method attempts to remove a submitted message from the message store's outgoing queue.

Notes to Callers

After a message is submitted, aborting the submission by calling AbortSubmit is the only action that can be performed on the message. Do not expect AbortSubmit always to succeed. Depending on how the underlying messaging system is implemented, it might not be possible to cancel the sending of the message.

See Also

IMessage::SubmitMessage