PROPSHEETPAGE

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This structure defines a page in a property sheet.

typedef struct _PROPSHEETPAGE {
DWORD
dwSize
;
DWORD
dwFlags
;
HINSTANCE
hInstance
;
union {
LPCSTR  
pszTemplate
;
LPCDLGTEMPLATE
pResource
;
};
union {
HICON
hIcon
;
LPCSTR
pszIcon
;
};
LPCSTR
pszTitle
;
DLGPROC
pfnDlgProc
;
LPARAM
lParam
;
LPFNPSPCALLBACK
pfnCallback
;
UINT FAR *
pcRefParent
; }
PROPSHEETPAGE, FAR *LPPROPSHEETPAGE;
typedef const PROPSHEETPAGE FAR *LPCPROPSHEETPAGE;

Members

dwSize

Specifies the size, in bytes, of the structure. The size includes any extra application-defined data at the end of the structure.

dwFlags

Specifies a bitmask of flags that enable optional attributes of the property sheet page, and indicate the valid members of the PROPSHEETPAGEstructure. This member can be any combination of the following values:

Value	Description
PSP_DEFAULT	Uses the default meaning for all structure members.
PSP_DLGINDIRECT	Creates the page from the dialog box template in memory pointed to by the pResourcemember. The Win32 PropertySheetfunction assumes that the template is in writeable memory; a read-only template will cause an exception on some versions of Windows. If this flag is not set, the page loads the dialog box template from the resource identified by the pszTemplatemember.
PSP_HASHELP	Enables the property sheet Help button when this page is active.
PSP_USECALLBACK	Calls the function specified by pfnCallbackwhen creating or destroying the property sheet page defined by this structure.
PSP_HICON	Not supported.
PSP_PREMATURE	The page is created when the property sheet is created. Usually, the page is not created until the first time it is selected.
PSP_USEICONID	Not supported.
PSP__USEREFPARENT	Maintains the reference count specified by pcRefParentfor the lifetime of the property sheet page created from this structure.
PSP_USETITLE	Uses pszTitleas the title of the property sheet dialog box instead of the title stored in the dialog box template.
PSP_RTLREADING	When this page is active, displays the text of pszTitleusing right-to-left reading order on Hebrew or Arabic systems.

hInstance

Handle to the instance from which to load the dialog box template, icon, or title string resource.

pszTemplate

Pointer to a dialog box template to use to create the page. This member can specify either the resource identifier of the template or the address of a string that specifies the name of the template. If dwFlagsincludes the PSP_DLGINDIRECT value, this member is ignored.

pResource

Pointer to a dialog box template in memory. The Win32 PropertySheetfunction assumes that the template is in writeable memory; a read-only template will cause an exception on some versions of Windows. If dwFlagsdoes not include the PSP_DLGINDIRECT value, this member is ignored.

hIcon

Ignored. Must be NULL.

pszIcon

Ignored. Must be NULL.

pszTitle

Pointer to the null-terminated string that contains the title of the property sheet dialog box. This title overrides the title specified in the dialog box template. This member can specify either the identifier of a string resource or the pointer to a string that specifies the title. If dwFlagsdoes not include the PSP_USETITLE value, this member is ignored.

pfnDlgProc

Pointer to the dialog box procedure for the page. The dialog box procedure must not call the Win32 EndDialogfunction.

lParam

Application-defined data.

pfnCallback

Pointer to an application-defined callback function that is called when the page is created and when it is about to be destroyed. For more information about the Win32 callback function, see PropSheetPageProc. If dwFlagsdoes not include the PSP_USECALLBACK value, this member is ignored.

pcRefParent

Pointer to the reference count value. If dwFlagsdoes not include the PSP_USERREFPARENT value, this member is ignored.

Remarks

When the PropertySheetfunction creates the page, the dialog box procedure for the page receives a WM_INITDIALOGmessage. The lParamparameter of this message points to the PROPSHEETPAGE structure used to create the page.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Prsht.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.