Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

OleCreatePropertyFrame function

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


HRESULT 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

hwndOwner [in]

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

x [in]

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

y [in]

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

lpszCaption [in]

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

cObjects [in]

Number of object pointers passed in ppUnk.

ppUnk [in]

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.

cPages [in]

Number of property pages specified in pPageCIsID.

pPageClsID [in]

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

lcid [in]

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

dwReserved [in]

Reserved for future use; must be zero.

pvReserved [in]

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:

Return codeDescription
S_OK

The dialog box was invoked and operated successfully.

E_POINTER

The address in lpszCaption, ppUnk, or pPageCIsID is not valid. For example, any one of them may be NULL.

 

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleCtl.h

Library

OleAut32.lib

DLL

OleAut32.dll

See also

IPropertyPage::SetObjects
IPropertyPageSite::GetLocaleID

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.