IMimeMessageW::GetAddressFormatW method

  • Article

Gets a set of addresses in a text-based format.

Syntax

HRESULT GetAddressFormatW(
  [in]  DWORD         dwAdrType,
  [in]  ADDRESSFORMAT format,
  [out] LPWSTR        *ppwszFormat
);

Parameters

dwAdrType [in]

Type: DWORD

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

format [in]

Type: ADDRESSFORMAT

Specifies a value from ADDRESSFORMAT that indicates the format of the text-based address.

ppwszFormat [out]

Type: LPWSTR*

Receives a pointer to the address format string. The client is responsible for freeing this pointer by calling IMalloc::Free.

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 ppwszFormat is NULL.
E_OUTOFMEMORY
 Indicates that an attempt to allocate memory failed.
MIME_E_NO_DATA
 Indicates that no address was found with type dwAdrType.

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)