IExchExtMessageEvents::OnReadComplete

Platform SDK: Exchange Server

IExchExtMessageEvents::OnReadComplete

Enables extension objects to roll back their implementation of the IExchExtMessageEvents::OnRead method in case of an error or to release resources allocated by the OnRead method.

Quick Info

See IExchExtMessageEvents : IUnknown.

HRESULT OnReadComplete(
  LPEXCHEXTCALLBACK lpeecb,   
  ULONG ulFlags               
);

Parameters

lpeecb

[in] Pointer to the IExchExtCallback interface. The lpeecb parameter is used to determine information about the message being read and the window whose controls are to be populated.

ulFlags

EEME_FAILED: The check names operation could not be completed successfully. See the text provided in the definition of the IExchExtMessageEvents interface in this reference.
EEME_COMPLETE_FAILED: See the text provided in the definition of the IExchExtMessageEvents interface in this reference.

Return Values

S_OK: The extension object handled the event. Microsoft Exchange will consider the task handled.
S_FALSE: The extension object did nothing or added additional behavior. Microsoft Exchange will continue to call extensions or complete the work itself.

Remarks

Microsoft Exchange calls the IExchExtMessageEvents::OnReadComplete method when it has finished reading the properties of a message for display to the user in a standard form.

If an error occurs, OnReadComplete should display an error message and return an error. Microsoft Exchange will then call each extension object again with OnReadComplete with ulFlags = EEME_FAILED to indicate that the read operation failed. Microsoft Exchange will not continue to read the message, nor will it display an error message, but will stop the user action that caused the read operation.

OnReadComplete should call the IExchExtCallback::GetObject method to determine the message identifier of the item being read and its container. The container is usually a folder, but it can also be a message or an information store.