通过

CommonPropertySheetUIA 函数 （compstui.h）

  • 项目

CPSUI 的 CommonPropertySheetUI 函数显示属性表页，并允许用户修改显示的值。

语法

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

参数

hWndOwner

调用方提供的窗口句柄标识要放置新属性表页的窗口。

pfnPropSheetUI

调用方提供的指向 PFNPROPSHEETUI类型回调函数的指针。

lParam

调用方提供的值，用作 pfnPropSheetUI 函数的输入参数。 此值可以是指针。

pResult

调用方提供的指向接收 pfnPropSheetUI 函数的最终返回状态的 DWORD 的指针。 如果 NULL，则不返回最终返回状态。 有关详细信息，请参阅以下“备注”部分。

返回值

CommonPropertySheetUI 函数返回以下值之一：

返回代码 描述
CPSUI_CANCEL pfnPropSheetUI 函数返回负值。
CPSUI_OK 作成功。
CPSUI_REBOOTSYSTEM 作成功，并且对话框过程发送了 PSM_REBOOTSYSTEM 消息。
CPSUI_RESTARTWINDOWS 作成功，并且对话框过程发送了 PSM_RESTARTWINDOWS 消息。
ERR_CPSUI 前缀的错误代码 发生失败。 ERR_CPSUI前缀错误代码在 compstui.h 中定义。

言论

CommonPropertySheetUI 函数是 CPSUI 的应用程序入口点。 CPSUI 应用程序（如基于 NT 的Microsoft作系统打印后台处理程序）可以调用函数，将一个或多个属性表页添加到预定义的父窗口。 CPSUI 显示页面，允许用户修改页面，并通过回调函数通知用户活动的应用程序。

当 Win32 应用程序调用后台处理程序的 DocumentProperties 或 PrinterProperties 函数时，基于 NT 的作系统打印后台处理程序将调用 CommonPropertySheetUI 函数。

pfnPropSheetUI 参数指定的回调函数负责描述要添加的属性表页。 有关详细信息，请参阅 PFNPROPSHEETUI 函数类型的说明。

作顺序如下所示：

  1. CommonPropertySheetUI 函数调用 pfnPropSheetUI 回调，以便回调可以通过调用 CPSUI 的 ComPropSheet 函数来描述要添加的页面。

  2. 如果 pfnPropSheetUI 回调成功，CommonPropertySheetUI 函数将显示新的属性表页，并允许用户修改页面值。

  3. 如果用户修改页面值，页事件回调 通知更改的应用程序。

  4. 当用户选择“确定”“ 或 ”取消“ 按钮时，CommonPropertySheetUI 函数将销毁显示的页面并返回。

有关作顺序的详细信息，请参阅 将 CPSUI 与打印机驱动程序配合使用，请参阅题为 CPSUI部分。

CommonPropertySheetUI 函数实际上多次调用 pfnPropSheetUI 回调，并在回调的 PROPSHEETUI_INFO 结构中指定不同的 Reason 成员值。 每次回调返回时，都会在PROPSHEETUI_INFO结构的 结果 成员中放置结果状态。 CommonPropertySheetUI 函数返回时，它将 Result 的最终内容复制到 pResult指向的位置。

要求

要求 价值
目标平台 桌面
标头 compstui.h （包括 Compstui.h）