IMimeMessage::EnumAddressTypes method

Enumerates a set of addresses from the message.

Syntax

HRESULT EnumAddressTypes(
  [in]  DWORD                 dwAdrTypes,
  [in]  DWORD                 dwProps,
  [out] IMimeEnumAddressTypes **ppEnum
);

Parameters

dwAdrTypes [in]

Type: DWORD

Specifies the type of addresses to return. See ADDRESSPROPS.dwAdrType for a list of possible values. This parameter can also include values created by the RegisterAddressType method.

dwProps [in]

Type: DWORD

Specifies which properties to return in each ADDRESSPROPS structure in a call to RegisterAddressType. See ADDRESSPROPS.dwProps for a list of possible values.

ppEnum [out]

Type: IMimeEnumAddressTypes**

Receives a pointer to an IMimeEnumAddressTypes object. The client is responsible for releasing the object.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
Indicates success.
E_FAIL
Indicates that an unknown error has occurred.
E_INVALIDARG
Indicates that ppEnum is NULL.
E_OUTOFMEMORY
Indicates that an attempt to allocate memory failed.

Remarks

This method is equivalent to:

pMessage->BindToObject(HBODY_ROOT, IID_IMimeAddressTable, (LPVOID *)&pAddressTable);

pAddressTable->EnumTypes(dwAdrTypes, dwProps, ppEnum);

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Product
Outlook Express 6.0
Header
Mimeole.h
IDL
Mimeole.idl
DLL
Inetcomm.dll (version 6.0 or later)