IMAPISession::EnumAdrTypes

The IMAPISession::EnumAdrTypes method returns the address types that can be handled by all of the transport providers in the session.

Quick Info

See IMAPISession : IUnknown.

HRESULT EnumAdrTypes(
  ULONG ulFlags,                     
  ULONG FAR * lpcAdrTypes,           
  LPTSTR FAR * FAR * lpppszAdrTypes  
);

Parameters

ulFlags

[in] Bitmask of flags that indicates the format for the returned address types. The following flag can be set:

MAPI_UNICODE: The address types are in Unicode format. If the MAPI_UNICODE flag is not set, the address types are in ANSI format.

lpcAdrTypes

[out] Pointer to a count of address types pointed to by the lpppszAdrTypes parameter.

lpppszAdrTypes

[out] Pointer to an array of pointers to address types.

Return Values

S_OK: The address types were successfully retrieved.

Remarks

The IMAPISession::EnumAdrTypes method returns a list of the address types that can be handled by all of the active transport providers in the session. The address types for transport providers that are not currently loaded are not included in the list. Transport providers register to handle one or more address types when MAPI calls their IXPLogon::AddressTypes method.

Notes to Callers

Call MAPIFreeBuffer to release the string array pointed to by the lpppszAdrTypes parameter.