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 应用程序 (,例如基于 Microsoft NT 的操作系统打印后台处理程序) 可以调用 函数,将一个或多个属性表页添加到预定义的父窗口。 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结构的 Result 成员中。 当 CommonPropertySheetUI 函数返回时,它将 Result 的最终内容复制到 pResult 指向的位置。

要求

要求
目标平台 桌面
标头 compstui.h (包括 Compstui.h)