Share via

IMimeAddressTable::GetFormat method

  • Article

Gets a text-based representation for a group of addresses that match a specified set of address types.

Syntax

HRESULT GetFormat(
  [in]  DWORD         dwAdrType,
  [in]  ADDRESSFORMAT format,
  [out] LPSTR         *ppszFormat
);

Parameters

dwAdrType [in]

Type: DWORD

Specifies an IAT_xxx bitmask (see ADDRESSPROPS for the list of bitmask values) that indicates the types of addresses to count. The bitmask may also include values for addresses types created by the RegisterAddressType method.

format [in]

Type: ADDRESSFORMAT

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

ppszFormat [out]

Type: LPSTR*

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 ppszFormat 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)