IMAPISupport::DoConfigPropsheet

The IMAPISupport::DoConfigPropsheet method displays a configuration property sheet.

Quick Info

HRESULT DoConfigPropsheet(
  ULONG ulUIParam,           
  ULONG ulFlags,             
  LPTSTR lpszTitle,          
  LPMAPITABLE lpDisplayTable,   
  LPMAPIPROP lpConfigData,   
  ULONG ulTopPage            
);

Parameters

ulUIParam: [in] Handle of the parent window for the property sheet.
ulFlags: Reserved; must be zero.
lpszTitle: [in] Pointer to the title of the property sheet.
lpDisplayTable: [in] Pointer to the display table that describes the controls to appear on the property sheet.
lpConfigData: [in] Pointer to the IMAPIProp implementation to be used for accessing the configuration properties to be displayed on the property sheet.
ulTopPage: [in] A zero-based index to the default top page of the property sheet.

Return Values

S_OK: The configuration property sheet was displayed.

Remarks

The IMAPISupport::DoConfigPropSheet method is implemented for all support objects. DoConfigPropSheet provides a standard user interface for displaying the properties of service providers and message services. Microsoft strongly recommends that this standard dialog box be used for all configuration property displays so that users benefit from a consistent Windows interface.

Service providers call DoConfigPropSheet as part of their implementation of the IMAPIStatus::SettingsDialog method or from a button used to display details on properties. Message services call DoConfigPropSheet from their message service entry point function.

Notes to Callers

You can create the display table pointed to by the lpDisplayTable parameter by calling the BuildDisplayTable function or with custom code.