PropSheet_SetHeaderSubTitle macro

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   hWizardDlg,
   int    iPageIndex,
   LPCSTR pszHeaderSubTitle
);

Parameters

hWizardDlg

Type: HWND

Handle to the wizard's window.

iPageIndex

Type: int

Zero-based index of the page.

pszHeaderSubTitle

Type: LPCSTR

New header subtitle.

Return value

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Prsht.h

See also

Reference
PropSheet_HwndToIndex
PropSheet_IdToIndex
PropSheet_PageToIndex

 

 

Show: