IExchExtPropertySheets::GetPages

Adds property sheet pages to the current list of pages.

Quick Info

See IExchExtPropertySheets : IUnknown.

HRESULT GetPages(
  LPEXCHEXTCALLBACK lpeecb,   
  ULONG ulFlags,           
  LPPROPSHEETPAGE lppsp,   
  ULONG FAR * lpcpsp       
);
 

Parameters

lpeecb

[in] Pointer to the IExchExtCallback interface.

ulFlags

[in] Bitmask of flags used to indicate the type of property sheet being displayed. The following flags can be set:

EEPS_MESSAGE

A message's property sheet.

EEPS_FOLDER

A folder's property sheet.

EEPS_STORE

A store's property sheet.

EEPS_TOOLSOPTIONS

The Tools.Options property sheet.

lppsp

[out] Pointer to a pointer to a list of property sheet pages the extension will fill.

lpcpsp

[out] Pointer to a variable containing the number of property sheet pages actually filled in by the extension object. The number must be less than or equal to the maximum requested by the IExchExtPropertySheets::GetMaxPageCount method.

Return Values

S_OK

No error occurred.

Remarks

Microsoft Exchange calls the IExchExtPropertySheets::GetPages method when it is building a property sheet and needs each extension object to fill in any pages that will be appended. Microsoft Exchange, not the extension object, handles the allocation of the page array pointed to by the lppsp parameter. Microsoft Exchange allocates this array after it calls the extension object and gets the value returned by the IExchExtPropertySheets::GetMaxPageCount method. The extension object should not allocate its own pages in the lppsp parameter, nor should it free them when the IExchExtPropertySheets::FreePages method is called. Instead, it should free the additional resources added during the call to GetPages.

The Windows 95 property sheet structures are used to describe the pages.