Edit

Share via

PSPINFO structure (compstui.h)

  • Article

The PSPINFO structure is used as an input parameter to a property sheet page's dialog box procedure, when the Windows message is WM_INITDIALOG. The dialog box procedure's address is specified in a DLGPAGE structure.

Syntax

typedef struct _PSPINFO {
  WORD            cbSize;
  WORD            wReserved;
  HANDLE          hComPropSheet;
  HANDLE          hCPSUIPage;
  PFNCOMPROPSHEET pfnComPropSheet;
} PSPINFO, *PPSPINFO;

Members

cbSize

CPSUI-supplied size, in bytes, of the PSPINFO structure.

wReserved

Reserved.

hComPropSheet

CPSUI-supplied handle to the parent of the page whose handle is contained in hCPSUIPage.

hCPSUIPage

CPSUI-supplied handle to the property sheet page.

pfnComPropSheet

CPSUI-supplied pointer to its ComPropSheet function.

Remarks

Before CPSUI calls CreatePropertySheetPage to create a property sheet page, it expands the size of the standard PROPSHEETPAGE structure in order to append a PSPINFO structure. When the operating system calls a dialog box procedure (pointed to by a DLGPAGE structure) and specifies a WM_INITDIALOG message, the function's lParam member points to the expanded PROPSHEETPAGE structure containing the PSPINFO structure.

To obtain the PSPINFO structure's address, use the PPSPINFO_FROM_WM_INITDIALOG_LPARAM macro (defined in compstui.h) as follows:

PPSPINFO pPspInfo;
if (Msg == WM_INITDIALOG) {
    pPspInfo = PPSPINFO_FROM_WM_INITDIALOG_LPARAM(lParam);
}

The PSPINFO structure pointer can be saved for later use, but the structure's contents must not be modified.

Requirements

Requirement Value
Header compstui.h (include Compstui.h)