Platform SDK: SMTP Server Events

IMailMsgBind::GetProperties

[This is preliminary documentation and subject to change.]

Read the MailMsg objects properties into a stream with optional asynchronous completion.

HRESULT GetProperties(
  [in] IMailMsgPropertyStream *pStream,
  [in] DWORD dwFlags,
  [in,unique] IMailMsgNotify *pNotify
);
pStream
A reference to the MailMsg object into which to write the property stream.
dwFlags
Flags indicating the nature of the method's execution. The flags should be either MAILMSG_GETPROPS_INCREMENTAL or MAILMSG_GETPROPS_COMPLETE. Either flag may also include MAILMSG_GETPROPS_CLEAR_DIRTY.
pNotify
Interface to notify for asynchronous completion. If this value is NULL, then the method will complete synchronously. Even if this value is non-NULL, the method may still complete synchronously (i.e. it may return S_OK instead of MAILMSG_S_PENDING).

Return Values

Value Description
S_OK Success. The method completed synchronously.
MAILMSG_S_PENDING Success. The operation will complete asynchronously. When it completes, you will be notified through the interface you passed using the pNotify parameter. The result of the operation will be returned with the notification callback method.

See Also

IMailMsgNotify Interface

IMailMsgNotify.Notify