Platform SDK: SMTP Server Events

IMailMsgRecipients::GetNextRecipient

[This is preliminary documentation and subject to change.]

Returns the next recipient in the chain of domains that match the filtering criteria set for the filter context.

HRESULT GetNextRecipient(
[in,unique] LPRECIPIENT_FILTER_CONTEXT pContext,
[out] DWORD* pdwRecipientIndex
);
pContext
Specifies the filter context. This context must have been previously initialized by InitializeRecipientFilterContext.

pdwRecipientIndex

Receives the next recipient with matching criteria.

Return Values

Value Description
S_OK Success.
HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS) No more recipients match the criteria.
HRESULT_FROM_WIN32(ERROR_INVALID_DATA) The context specified is invalid.
E_INVALIDARG Failure. One or more arguments are invalid
E_POINTER Failure. The context passed in is NULL.