структура INSERTPSUIPAGE_INFO (compstui.h)

Структура INSERTPSUIPAGE_INFO используется в качестве входного параметра для функции ComPropSheet CPSUI, если код функции CPSFUNC_INSERT_PSUIPAGE. Все значения элементов должны быть предоставлены вызывающим элементом ComPropSheet .

Синтаксис

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

Члены

cbSize

Размер структуры INSERTPSUIPAGE_INFO в байтах, предоставленный вызывающим абонентом.

Type

Указанное вызывающим целочисленное значение, указывающее тип запрашиваемой вставки. Член может содержать одну из следующих констант:

PSUIPAGEINSERT_DLL

CPSUI вызывает указанную типированную функцию PFNPROPSHEETUI со значением причины PROPSHEETUI_REASON_INIT. Функция содержится в отдельной библиотеке DLL.

PSUIPAGEINSERT_GROUP_PARENT

CPSUI создает новый родительский элемент группы.

PSUIPAGEINSERT_HPROPSHEETPAGE

CPSUI вставляет страницу, созданную путем вызова Метода CreatePropertySheetPage.

(Это эквивалентно вызову ComPropSheet с кодом функции CPSFUNC_ADD_HPROPSHEETPAGE.)

PSUIPAGEINSERT_PCOMPROPSHEETUI

CPSUI вставляет страницы, описываемые структурой COMPROPSHEETUI .

(Это эквивалентно вызову ComPropSheet с кодом функции CPSFUNC_ADD_PCOMPROPSHEETUI.)

PSUIPAGEINSERT_PFNPROPSHEETUI

CPSUI вызывает указанную типированную функцию PFNPROPSHEETUI со значением причины PROPSHEETUI_REASON_INIT.

(Это эквивалентно вызову ComPropSheet с кодом функции CPSFUNC_ADD_PFNPROPSHEETUI.)

PSUIPAGEINSERT_PROPSHEETPAGE

CPSUI вставляет страницу, описанную указанной структурой PROPSHEETPAGE.

(Это эквивалентно вызову ComPropSheet с кодом функции CPSFUNC_ADD_PROPSHEETPAGE.)

Mode

Значение, предоставленное вызывающей стороны, указывающее, куда CPSUI следует вставлять новые страницы. Это должно быть одно из следующих значений:

INSPSUIPAGE_MODE_AFTER

CPSUI вставляет страницы после страницы, определенной дескриптором страницы CPSUI, который указан параметром lParam1 , в ComPropSheet.

INSPSUIPAGE_MODE_BEFORE

CPSUI вставляет страницы перед страницей, определенной дескриптором страницы CPSUI, заданным параметром lParam1 , в ComPropSheet.

INSPSUIPAGE_MODE_FIRST_CHILD

CPSUI вставляет страницы в качестве первых дочерних элементов родительской группы, определяемой параметром hComPropSheet , в ComPropSheet.

Параметр lParam1 для ComPropSheet игнорируется.

INSPUIPAGE_MODE_INDEX

CPSUI вставляет страницы как дочерние элементы родительской группы, определяемой параметром hComPropSheet , в ComPropSheet.

Параметр lParam1 для ComPropSheet указывает отсчитываемый от нуля индекс, определяющий, где в наборе дочерних элементов должны быть вставлены указанные страницы. Если значение lParam1 равно 0, страницы вставляются начиная со страницы 1; Если значение lParam1 равно 1, страницы вставляются начиная со страницы 2; и так далее. Если индекс больше, чем количество существующих дочерних элементов, новые страницы добавляются как последние дочерние элементы. Значение lParam1 должно быть указано как HINSPSUIPAGE_INDEX(index).

INSPSUIPAGE_MODE_LAST_CHILD

CPSUI вставляет страницы как последние дочерние элементы родительской группы, определяемые параметром hComPropSheet , в ComPropSheet.

Параметр lParam1 для ComPropSheet игнорируется.

dwData1

См. раздел "Примечания " ниже.

dwData2

См. раздел "Примечания " ниже.

dwData3

См. раздел "Примечания " ниже.

Комментарии

Члены dwData1, dwData2 и dwData3 содержат значения, предоставленные вызывающим, которые зависят от содержимого элемента Type следующим образом:

Элемент типа содержит PSUIPAGEINSERT_DLL

dwData1 — предоставленный вызывающим элементом указатель на строку с завершением NULL, представляющую имя пути DLL.

dwData2 — предоставленный вызывающим объектом указатель на строку с завершением NULL, представляющую имя типизированной функции PFNPROPSHEETUI , содержащейся в указанной библиотеке DLL.

dwData3 — 32-разрядное значение, предоставленное вызывающим абонентом, переданное функции PFNPROPSHEETUI для ее параметра lParam .

Элемент типа содержит PSUIPAGEINSERT_GROUP_PARENT

dwData1 — не используется, должно быть равно нулю.

dwData2 — не используется, должно быть равно нулю.

dwData3 — не используется, должно быть равно нулю.

Элемент типа содержит PSUIPAGEINSERT_HPROPSHEETPAGE

dwData1 — предоставленный вызывающим элементом дескриптор для страницы свойств, возвращаемый методом CreatePropertySheetPage.

dwData2 — не используется, должно быть равно нулю.

dwData3 — не используется, должно быть равно нулю.

Элемент типа содержит PSUIPAGEINSERT_PCOMPROPSHEETUI

dwData1 — указатель на структуру COMPROPSHEETUI, предоставленный вызывающим абонентом.

dwData2 — при успешном выполнении получает количество вставленных страниц. При сбое получает код ошибки с ERR_CPSUI префиксом.

dwData3 — не используется, должно быть равно нулю.

Элемент типа содержит PSUIPAGEINSERT_PFNPROPSHEETUI

dwData1 — предоставленный вызывающим указателем на функцию типа PFNPROPSHEETUI.

dwData2 — 32-разрядное значение, предоставленное вызывающей стороны, которое передается в функцию типа PFNPROPSHEETUI для ее параметра lParam .

dwData3 — не используется, должно быть равно нулю.

Элемент типа содержит PSUIPAGEINSERT_PROPSHEETPAGE

dwData1 — предоставленный вызывающим элементом указатель на структуру PROPSHEETPAGE.

dwData2 — не используется, должно быть равно нулю.

dwData3 — не используется, должно быть равно нулю.

Требования

Требование Значение
Заголовок compstui.h (включая Compstui.h)