OleCreatePropertyFrame function (olectl.h)

Invokes a new property frame, that is, a property sheet dialog box, whose parent is hwndOwner, where the dialog is positioned at the point (x,y) in the parent window and has the caption lpszCaption.

Syntax

WINOLECTLAPI OleCreatePropertyFrame(
  [in] HWND      hwndOwner,
  [in] UINT      x,
  [in] UINT      y,
  [in] LPCOLESTR lpszCaption,
  [in] ULONG     cObjects,
  [in] LPUNKNOWN *ppUnk,
  [in] ULONG     cPages,
  [in] LPCLSID   pPageClsID,
  [in] LCID      lcid,
  [in] DWORD     dwReserved,
  [in] LPVOID    pvReserved
);

Parameters

[in] hwndOwner

Handle to the parent window of the resulting property sheet dialog box.

[in] x

Reserved. Horizontal position for the dialog box relative to hwndOwner.

[in] y

Reserved. Vertical position for the dialog box relative to hwndOwner.

[in] lpszCaption

Pointer to the string used for the caption of the dialog box.

[in] cObjects

Number of object pointers passed in ppUnk.

[in] ppUnk

An array of IUnknown pointers on the objects for which this property sheet is being invoked. The number of elements in the array is specified by cObjects. These pointers are passed to each property page through IPropertyPage::SetObjects.

[in] cPages

Number of property pages specified in pPageCIsID.

[in] pPageClsID

Array of size cPages containing the CLSIDs of each property page to display in the property sheet.

[in] lcid

Locale identifier to use for the property sheet. Property pages can retrieve this identifier through IPropertyPageSite::GetLocaleID.

[in] dwReserved

Reserved for future use; must be zero.

[in] pvReserved

Reserved for future use; must be NULL.

Return value

This function supports the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED, as well as the following:

Remarks

The property pages to be displayed are identified with pPageClsID, which is an array of cPages CLSID values. The objects that are affected by this property sheet are identified in ppUnk, an array of size cObjects containing IUnknown pointers.

This function always creates a modal dialog box and does not return until the dialog box is closed.

Requirements

See also

IPropertyPage::SetObjects

IPropertyPageSite::GetLocaleID