PropSheet_SetHeaderSubTitle macro (prsht.h)

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.

Syntax

VOID PropSheet_SetHeaderSubTitle(
   HWND   hDlg,
   int    index,
   LPCSTR lpszText
);

Parameters

hDlg

Type: HWND

Handle to the wizard's window.

index

Type: int

Zero-based index of the page.

lpszText

Type: LPCSTR

New header subtitle.

Return value

Type: VOID

No return value.

Remarks

If you specify the current page, it will immediately be repainted to display the new subtitle.

Note  This macro is not supported when using the Aero wizard style (PSH_AEROWIZARD).

 

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	prsht.h

See also

PropSheet_HwndToIndex

PropSheet_IdToIndex

PropSheet_PageToIndex

Reference