IAddrBook::QueryDefaultRecipOpt

The IAddrBook::QueryDefaultRecipOpt method returns the recipient options that have been set for a particular address type by the transport provider.

Quick Info

See IAddrBook : IMAPIProp.

HRESULT QueryDefaultRecipOpt(
  LPTSTR lpszAdrType,            
  ULONG ulFlags,                 
  ULONG FAR * lpcValues,         
  LPSPropValue FAR * lppOptions  
);

Parameters

lpszAdrType

[in] Pointer to a valid address type. The lpszAdrType parameter must not be NULL.

ulFlags

[in] Bitmask of flags that controls the type of the string passed in with the lpszAdrType parameter. The following flag can be set:

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

lpcValues

[out] Pointer to the number of property values in the lppOptions parameter.

lppOptions

[out] Pointer to an array of SPropValue structures describing the recipient option properties.

Return Values

S_OK: The recipient option properties were successfully returned.

Remarks

Recipient options are properties that are set by a transport provider when MAPI calls its IXPLogon::RegisterOptions method. Not all transport providers register recipient options. Recipient options are usually, but not always, specific to a particular address type.

Clients and service providers call the IAddrBook::QueryDefaultRecipOpt method to programmatically retrieve the recipient options for a particular address type. If a client must display a dialog box with these options, the client should call the IAddrBook::RecipOptions method.

Transport providers can also register message options that apply to all recipients. For more information on registering options, see Implementing Message and Recipient Options with Transport Providers.