IMimePropertySchema::RegisterAddressType method

Registers a new address type in the MimeOLE global property schema.

Syntax

HRESULT RegisterAddressType(
  [in]  LPCSTR  pszName,
  [out] LPDWORD pdwAdrType
);

Parameters

pszName [in]

Type: LPCSTR

Specifies the name of the header for the new address type.

pdwAdrType [out]

Type: LPDWORD

Receives the value of the new address type.

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 pszName or pdwAdrType is NULL.
MIME_E_NO_MORE_ADDRESS_TYPES
Indicates that the maximum number of address types has been reached and no more new address types can be added. The maximum is 32 address types.

Remarks

MimeOLE defines a set of default address types in the IAT_xxx bitmask (see ADDRESSPROPS for the list of bitmask values). However, a client may need to register a new type of address. Address types are used with the IMimeAddressTable interface. If this function tries to register a name that is already registered as an address type, this function succeeds and returns the value for the existing address type in pdwAdrType.

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)