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

Структура PROPSHEETUI_INFO используется в качестве входного параметра для функций типа PFNPROPSHEETUI.

Синтаксис

typedef struct _PROPSHEETUI_INFO {
  WORD            cbSize;
  WORD            Version;
  WORD            Flags;
  WORD            Reason;
  HANDLE          hComPropSheet;
  PFNCOMPROPSHEET pfnComPropSheet;
  LPARAM          lParamInit;
  ULONG_PTR       UserData;
  ULONG_PTR       Result;
} PROPSHEETUI_INFO, *PPROPSHEETUI_INFO;

Члены

cbSize

Предоставленный CPSUI размер структуры PROPSHEETUI_INFO в байтах.

Version

Предоставленный CPSUI номер версии структуры PROPSHEETUI_INFO . Номер текущей версии определяется PROPSHEETUI_INFO_VERSION в compstui.h.

Flags

Битовые флаги, предоставляемые CPSUI. Определен следующий флаг:

Reason

Константа, предоставляемая CPSUI, указывающая действие, выполняемое на листе свойств функцией типа PFNPROPSHEETUI, в которую была передана структура PROPSHEETUI_INFO. Будет предоставлена одна из следующих констант:

• PROPSHEETUI_REASON_DESTROY

• PROPSHEETUI_REASON_GET_ICON

• PROPSHEETUI_REASON_GET_INFO_HEADER

• PROPSHEETUI_REASON_INIT

• PROPSHEETUI_REASON_SET_RESULT

Сведения о значении каждой константы см. в разделе Примечания описания PFNPROPSHEETUI .

hComPropSheet

Предоставленный CPSUI дескриптор родительской группы листов свойств. Этот дескриптор можно передать в функцию ComPropSheet CPSUI.

pfnComPropSheet

Адрес функции ComPropSheet CPSUI.

lParamInit

Значение, полученное в качестве параметра lParam для связанной функции PFNPROPSHEETUI при первом вызове функции с причиной PROPSHEETUI_REASON_INIT. Сведения о том, каким может быть это значение, см. в описании PFNPROPSHEETUI.

Это значение предоставляется CPSUI и допустимо для всех значений Reason .

UserData

Необязательное частное значение или указатель, предоставляемый связанной функцией типа PFNPROPSHEETUI, изначально заданной cpSUI в нулевом значении. Если функция сохраняет значение в UserData, то для последующих вызовов функции хранимое значение или указатель не изменяются, если не будет изменена функцией.

Result

Значение результата, предоставленное связанной функцией типа PFNPROPSHEETUI, изначально заданное cpSUI равным нулю. Если функция сохраняет результирующий результат в result, то для последующих вызовов функции сохраненное значение остается неизменным, если только функция не изменит ее.

Если адрес функции типа PFNPROPSHEETUI был указан в качестве аргумента CommonPropertySheetUI, последнее значение, хранящееся в result , возвращается в CommonPropertySheetUI в расположении, на которое указывает его аргумент pResult .

Требования