IWEExtendPropertySheet::CreatePropertySheetPages method (cluadmex.h)

Article
10/13/2021

Creates property pages for a cluster object and adds them to a Failover Cluster Administrator property sheet.

Syntax

HRESULT CreatePropertySheetPages(
  [in] IUnknown                 *piData,
  [in] IWCPropertySheetCallback *piCallback
);

Parameters

[in] piData

IUnknown interface pointer for retrieving information relating to the new property pages. By calling the IUnknown::QueryInterface method with the piData pointer, the following interfaces are available:

Depending on the type of cluster object for which property sheet pages are being created, a pointer to one of the following interfaces is also available:

IGetClusterNodeInfo, if the property page relates to a node.
IGetClusterGroupInfo, if the property page relates to a group.
IGetClusterNetworkInfo, if the property page relates to a network.
IGetClusterNetInterfaceInfo, if the property page relates to a network interface.
IGetClusterResourceInfo, if the property page relates to a resource.

[in] piCallback

Pointer to an IWCPropertySheetCallback interface implementation for adding property pages to the Cluster Administrator property sheet.

Return value

Return one of the following values or any HRESULT that describes the results of the operation.

Return code/value	Description
NOERROR 0	The operation was successful.
E_INVALIDARG 0x80070057	At least one of the parameters is invalid.
E_NOTIMPL 0x80004001	The extension does not support adding property pages.

Remarks

Failover Cluster Administrator calls an extension's CreatePropertySheetPages method to extend a property sheet to handle an additional cluster object.

Notes to Implementers

For each property page to be added

Use piData to call QueryInterface and retrieve an interface pointer for the cluster object associated with the page. For example, if you are adding a property page for a resource, you want to retrieve a pointer to the IGetClusterResourceInfo interface. Although it is possible to successfully query for interfaces that retrieve data unrelated to the target object, you should expect to receive errors when you attempt to call the methods.
To create the page, call the function CreatePropertySheetPage. To produce pages that look like the pages provided by Cluster Administrator, each new property page should be no larger than 252 dialog units wide and 218 dialog units high, and should contain two standard controls:
- For the object icon, an icon control positioned at (8,7) with a size of (18,20).
- For the object name, a static control positioned at (38,12) with a size of (206,10).
To add the page to the property sheet, call the IWCPropertySheetCallback::AddPropertySheetPage method pointed to by piCallback.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	cluadmex.h