Поделиться через

Функция CommonPropertySheetUIA (compstui.h)

  • Статья

Функция CommonPropertySheetUI CPSUI отображает страницы страниц свойств и позволяет пользователям изменять отображаемые значения.

Синтаксис

LONG CommonPropertySheetUIA(
  HWND           hWndOwner,
  PFNPROPSHEETUI pfnPropSheetUI,
  LPARAM         lParam,
  LPDWORD        pResult
);

Параметры

hWndOwner

Дескриптор окна, предоставленный вызывающим абонентом, идентифицирует окно, в которое будут помещены новые страницы свойств.

pfnPropSheetUI

Предоставленный вызывающим абонентом указатель на функцию обратного вызова, типизированной PFNPROPSHEETUI.

lParam

Предоставленное вызывающей стороны значение, которое используется в качестве входного аргумента для функции pfnPropSheetUI . Это значение может быть указателем.

pResult

Предоставленный вызывающим элементом указатель на DWORD, который получает окончательное состояние возвращаемого значения функции pfnPropSheetUI . Если значение РАВНО NULL, окончательное состояние возврата не возвращается. Дополнительные сведения см. в разделе "Примечания".

Возвращаемое значение

Функция CommonPropertySheetUI возвращает одно из следующих значений:

Код возврата Описание
CPSUI_CANCEL Функция pfnPropSheetUI вернула отрицательное значение.
CPSUI_OK Операция успешно выполнена.
CPSUI_REBOOTSYSTEM Операция выполнена успешно, и процедура диалогового окна отправила PSM_REBOOTSYSTEM сообщение.
CPSUI_RESTARTWINDOWS Операция выполнена успешно, и процедура диалогового окна отправила сообщение PSM_RESTARTWINDOWS .
ERR_CPSUI код ошибки с префиксом Произошел сбой. Коды ошибок с префиксом ERR_CPSUI определяются в файле compstui.h.

Комментарии

Функция CommonPropertySheetUI является точкой входа CPSUI для приложений. Приложение CPSUI (например, средство очереди печати на основе Microsoft NT) может вызывать функцию для добавления одной или нескольких страниц страниц страниц свойств в предопределенное родительское окно. CPSUI отображает страницы, позволяет пользователю изменять их и уведомляет о действиях пользователя с помощью функций обратного вызова.

Диспетчер очереди печати на основе NT вызывает функцию CommonPropertySheetUI, когда приложение Win32 вызывает функции DocumentProperties или PrinterProperties очереди очереди печати.

Функция обратного вызова, заданная параметром pfnPropSheetUI , отвечает за описание добавляемых страниц свойств. Дополнительные сведения см. в описании типа функции PFNPROPSHEETUI .

Последовательность операций выглядит следующим образом:

  1. Функция CommonPropertySheetUI вызывает обратный вызов pfnPropSheetUI , чтобы обратный вызов описать добавляемые страницы, вызвав функцию ComPropSheet CPSUI.

  2. Если обратный вызов pfnPropSheetUI выполняется успешно, функция CommonPropertySheetUI отображает новые страницы страниц свойств и позволяет пользователю изменять значения страниц.

  3. Если пользователь изменяет значения страницы, обратный вызов события страницы уведомляет приложение об изменениях.

  4. Когда пользователь нажимает кнопку ОК или Отмена , функция CommonPropertySheetUI удаляет отображаемые страницы и возвращает их.

Дополнительные сведения о последовательности операций см. в разделе Использование CPSUI с драйверами принтера в разделе CPSUI.

Функция CommonPropertySheetUI фактически вызывает обратный вызов pfnPropSheetUI несколько раз, указывая различные значения элементов Reason в структуре PROPSHEETUI_INFO обратного вызова. Каждый раз, когда обратный вызов возвращается, он помещает состояние результата в элемент Result структуры PROPSHEETUI_INFO. Когда функция CommonPropertySheetUI возвращает значение , она копирует окончательное содержимое Result в расположение, на которое указывает pResult.

Требования

Требование Значение
Целевая платформа Персональный компьютер
Верхняя часть compstui.h (включая Compstui.h)