Edit

Share via


prsht.h header

This header is used by multiple technologies. For more information, see:

prsht.h contains the following programming interfaces:

Functions

 
CreatePropertySheetPageA

Creates a new page for a property sheet. (ANSI)
CreatePropertySheetPageW

Creates a new page for a property sheet. (Unicode)
DestroyPropertySheetPage

Destroys a property sheet page. An application must call this function for pages that have not been passed to the PropertySheet function.
PropertySheetA

Creates a property sheet and adds the pages defined in the specified property sheet header structure. (ANSI)
PropertySheetW

Creates a property sheet and adds the pages defined in the specified property sheet header structure. (Unicode)
PropSheet_AddPage

Adds a new page to the end of an existing property sheet. You can use this macro or send the PSM_ADDPAGE message explicitly.
PropSheet_Apply

Simulates the selection of the Apply button, indicating that one or more pages have changed and the changes need to be validated and recorded. You can use this macro or send the PSM_APPLY message explicitly.
PropSheet_CancelToClose

Used when changes made since the most recent PSN_APPLY notification cannot be canceled. You can also send a PSM_CANCELTOCLOSE message explicitly.
PropSheet_Changed

Informs a property sheet that information in a page has changed. You can use this macro or send the PSM_CHANGED message explicitly.
PropSheet_EnableWizButtons

Enables or disables buttons in an Aero wizard. You can use this macro or send the PSM_ENABLEWIZBUTTONS message explicitly.
PropSheet_GetCurrentPageHwnd

Retrieves a handle to the window of the current page of a property sheet. You can use this macro or send the PSM_GETCURRENTPAGEHWND message explicitly.
PropSheet_GetResult

Used by modeless property sheets to retrieve the information returned to modal property sheets by PropertySheet. You can use this macro or sent the PSM_GETRESULT message explicitly.
PropSheet_GetTabControl

Retrieves the handle to the tab control of a property sheet. You can use this macro or send the PSM_GETTABCONTROL message explicitly.
PropSheet_HwndToIndex

Takes a window handle of the property sheet page and returns its zero-based index. You can use this macro or send the PSM_HWNDTOINDEX message explicitly.
PropSheet_IdToIndex

Takes the resource identifier (ID) of a property sheet page and returns its zero-based index. You can use this macro or send the PSM_IDTOINDEX message explicitly.
PropSheet_IndexToHwnd

Takes the index of a property sheet page and returns its window handle. You can use this macro or send the PSM_INDEXTOHWND message explicitly.
PropSheet_IndexToId

Takes the index of a property sheet page and returns its resource identifier (ID). You can use this macro or send the PSM_INDEXTOID message explicitly.
PropSheet_IndexToPage

Takes the index of a property sheet page and returns its HPROPSHEETPAGE handle. You can use this macro or send the PSM_INDEXTOPAGE message explicitly.
PropSheet_InsertPage

Inserts a new page into an existing property sheet. The page can be inserted either at a specified index or after a specified page. You can use this macro or send the PSM_INSERTPAGE message explicitly.
PropSheet_IsDialogMessage

Passes a message to a property sheet dialog box and indicates whether the dialog box processed the message. You can use this macro or send the PSM_ISDIALOGMESSAGE message explicitly.
PropSheet_PageToIndex

Takes the HPROPSHEETPAGE handle of a property sheet page and returns its zero-based index. You can use this macro or send the PSM_PAGETOINDEX message explicitly.
PropSheet_PressButton

Simulates the selection of a property sheet button. You can use this macro or send the PSM_PRESSBUTTON message explicitly.
PropSheet_QuerySiblings

Causes a property sheet to send the PSM_QUERYSIBLINGS message to each of its pages. You can use this macro or send the PSM_QUERYSIBLINGS message explicitly.
PropSheet_RebootSystem

Indicates the system needs to be restarted for the changes to take effect. You can use this macro or send the PSM_REBOOTSYSTEM message explicitly.
PropSheet_RecalcPageSizes

Recalculates the page size of a standard or wizard property sheet after pages have been added or removed. You can use this macro or send the PSM_RECALCPAGESIZES message explicitly.
PropSheet_RemovePage

Removes a page from a property sheet. You can use this macro or send the PSM_REMOVEPAGE message explicitly.
PropSheet_RestartWindows

Sends a PSM_RESTARTWINDOWS message indicating that Windows needs to be restarted for changes to take effect. You can use this macro or send the PSM_RESTARTWINDOWS message explicitly.
PropSheet_SetButtonText

Sets the text of a button in an Aero wizard. You can use this macro or send the PSM_SETBUTTONTEXT message explicitly.
PropSheet_SetCurSel

Activates the specified page in a property sheet. You can use this macro or send the PSM_SETCURSEL message explicitly.
PropSheet_SetCurSelByID

Activates the specified page in a property sheet based on the resource identifier of the page. You can use this macro or send the PSM_SETCURSELID message explicitly.
PropSheet_SetFinishText

Sets the text of the Finish button in a wizard, shows and enables the button, and hides the Next and Back buttons. You can use this macro or send the PSM_SETFINISHTEXT message explicitly.
PropSheet_SetHeaderSubTitle

Sets the subtitle text for the header of a wizard's interior page. You can use this macro or send the PSM_SETHEADERSUBTITLE message explicitly.
PropSheet_SetHeaderTitle

Sets the title text for the header of a wizard's interior page. You can use this macro or send the PSM_SETHEADERTITLE message explicitly.
PropSheet_SetNextText

Sets the text of the Next button in a wizard. You can use this macro or send the PSM_SETNEXTTEXT message explicitly.
PropSheet_SetTitle

Sets the title of a property sheet. You can use this macro or send the PSM_SETTITLE message explicitly.
PropSheet_SetWizButtons

Enables or disables the Back, Next, and Finish buttons in a wizard by posting a PSM_SETWIZBUTTONS message. You can use this macro or send the PSM_SETWIZBUTTONS message explicitly.
PropSheet_ShowWizButtons

Show or hide buttons in a wizard. You can use this macro or send the PSM_SHOWWIZBUTTONS message explicitly.
PropSheet_UnChanged

Informs a property sheet that information in a page has reverted to the previously saved state. You can use this macro or send the PSM_UNCHANGED message explicitly.

Callback functions

 
LPFNADDPROPSHEETPAGE

Specifies an application-defined callback function that a property sheet extension uses to add a page to a property sheet.
LPFNPSPCALLBACKA

Specifies an application-defined callback function that a property sheet calls when a page is created and when it is about to be destroyed. An application can use this function to perform initialization and cleanup operations for the page. (ANSI)
LPFNPSPCALLBACKW

Specifies an application-defined callback function that a property sheet calls when a page is created and when it is about to be destroyed. An application can use this function to perform initialization and cleanup operations for the page. (Unicode)
PFNPROPSHEETCALLBACK

An application-defined callback function that the system calls when the property sheet is being created and initialized.

Structures

 
PROPSHEETHEADERA_V2

The PROPSHEETHEADERA_V2 (ANSI) structure defines the frame and pages of a property sheet.
PROPSHEETHEADERW_V2

The PROPSHEETHEADERW_V2 (Unicode) structure defines the frame and pages of a property sheet.
PROPSHEETPAGEA_V2

The PROPSHEETPAGEA_V2 (ANSI) structure defines a page in a property sheet.
PROPSHEETPAGEA_V3

The PROPSHEETPAGEA_V3 (ANSI) structure defines a page in a property sheet.
PROPSHEETPAGEA_V4

The PROPSHEETPAGEA_V4 (ANSI) structure defines a page in a property sheet.
PROPSHEETPAGEW_V2

The PROPSHEETPAGEW_V2 (Unicode) structure defines a page in a property sheet.
PROPSHEETPAGEW_V3

The PROPSHEETPAGEW_V3 (Unicode) structure defines a page in a property sheet.
PROPSHEETPAGEW_V4

The PROPSHEETPAGEW_V4 (Unicode) structure defines a page in a property sheet.
PSHNOTIFY

Contains information for the property sheet notification messages.