INSERTPSUIPAGE_INFO structure (compstui.h)

Article
11/24/2022

The INSERTPSUIPAGE_INFO structure is used as an input parameter to CPSUI's ComPropSheet function, if the function code is CPSFUNC_INSERT_PSUIPAGE. All member values must be supplied by the ComPropSheet caller.

Syntax

typedef struct _INSERTPSUIPAGE_INFO {
  WORD      cbSize;
  BYTE      Type;
  BYTE      Mode;
  ULONG_PTR dwData1;
  ULONG_PTR dwData2;
  ULONG_PTR dwData3;
} INSERTPSUIPAGE_INFO, *PINSERTPSUIPAGE_INFO;

Members

cbSize

Caller-supplied size, in bytes, of the INSERTPSUIPAGE_INFO structure.

Type

Caller-supplied integer value indicating the type of insertion being requested. The member can contain one of the following constants:

PSUIPAGEINSERT_DLL

CPSUI calls the specified PFNPROPSHEETUI typed function, with a reason value of PROPSHEETUI_REASON_INIT. The function is contained in a separate DLL.

PSUIPAGEINSERT_GROUP_PARENT

CPSUI creates a new group parent.

PSUIPAGEINSERT_HPROPSHEETPAGE

CPSUI inserts a page that has been created by calling CreatePropertySheetPage.

(This is equivalent to calling ComPropSheet with a function code of CPSFUNC_ADD_HPROPSHEETPAGE.)

PSUIPAGEINSERT_PCOMPROPSHEETUI

CPSUI inserts pages described by a COMPROPSHEETUI structure.

(This is equivalent to calling ComPropSheet with a function code of CPSFUNC_ADD_PCOMPROPSHEETUI.)

PSUIPAGEINSERT_PFNPROPSHEETUI

CPSUI calls the specified PFNPROPSHEETUI typed function, with a reason value of PROPSHEETUI_REASON_INIT.

(This is equivalent to calling ComPropSheet with a function code of CPSFUNC_ADD_PFNPROPSHEETUI.)

PSUIPAGEINSERT_PROPSHEETPAGE

CPSUI inserts the page described by the specified PROPSHEETPAGE structure.

(This is equivalent to calling ComPropSheet with a function code of CPSFUNC_ADD_PROPSHEETPAGE.)

Mode

Caller-supplied value indicating where CPSUI should insert the new pages. It must be one of the following values:

INSPSUIPAGE_MODE_AFTER

CPSUI inserts pages after the page identified by the CPSUI page handle that is specified by the lParam1 parameter to ComPropSheet.

INSPSUIPAGE_MODE_BEFORE

CPSUI inserts pages before the page identified by the CPSUI page handle that is specified by the lParam1 parameter to ComPropSheet.

INSPSUIPAGE_MODE_FIRST_CHILD

CPSUI inserts pages as the first children of the parent group identified by the hComPropSheet parameter to ComPropSheet.

The lParam1 parameter to ComPropSheet is ignored.

INSPUIPAGE_MODE_INDEX

CPSUI inserts pages as children of the parent group identified by the hComPropSheet parameter to ComPropSheet.

The lParam1 parameter to ComPropSheet specifies a zero-based index identifying where, within the set of children, the specified pages should be inserted. If lParam1 is 0, the pages are inserted starting at page 1; if lParam1 is 1, the pages are inserted starting at page 2; and so on. If the index is greater than the number of existing children, the new pages are added as the last children. The lParam1 value must be specified as HINSPSUIPAGE_INDEX(index).

INSPSUIPAGE_MODE_LAST_CHILD

CPSUI inserts pages as the last children of the parent group identified by the hComPropSheet parameter to ComPropSheet.

The lParam1 parameter to ComPropSheet is ignored.

dwData1

See the Remarks section below.

dwData2

See the Remarks section below.

dwData3

See the Remarks section below.

Remarks

dwData1, dwData2, and dwData3 members contain caller-supplied values that depend on the contents of the Type member, as follows:

Type member contains PSUIPAGEINSERT_DLL

dwData1 - Caller-supplied pointer to a NULL-terminated string representing the DLL path name.

dwData2 - Caller-supplied pointer to a NULL-terminated string representing the name of a PFNPROPSHEETUI typed function, contained in the specified DLL.

dwData3 - Caller-supplied 32-bit value, passed to the PFNPROPSHEETUI-typed function for its lParam parameter.