IAddrBook::QueryDefaultRecipOpt
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Returns the recipient options that have been set for a particular address type by the transport provider.
HRESULT QueryDefaultRecipOpt(
LPSTR lpszAdrType,
ULONG ulFlags,
ULONG FAR * lpcValues,
LPSPropValue FAR * lppOptions
);
Parameters
lpszAdrType
[in] A pointer to a valid address type. This parameter must be an ANSI string and must not be NULL.ulFlags
[in] Reserved. Must be NULL.lpcValues
[out] A pointer to the number of property values in the lppOptions parameter.lppOptions
[out] A pointer to an array of SPropValue structures that describe the recipient option properties.
Return Value
- 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 QueryDefaultRecipOpt method to programmatically retrieve the recipient options for a particular address type. If a client must display a dialog box that has 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 about registering options, see Implementing Message and Recipient Options.
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
MainDlg.cpp |
CMainDlg::OnQueryDefaultRecipOpt |
MFCMAPI uses the QueryDefaultRecipOpt method to obtain the default recipient options for the specified address type. |
See Also
Reference
IMAPISession::QueryDefaultMessageOpt