CommonPropertySheetUIA 函式 (compstui.h)

  • 發行項

CPSUI 的 CommonPropertySheetUI 函式會顯示屬性表頁面，並允許使用者修改顯示的值。

語法

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

參數

hWndOwner

呼叫端提供的視窗句柄，識別要放置新屬性表頁面的視窗。

pfnPropSheetUI

呼叫端提供的 PFNPROPSHEETUI 型別回呼函式指標。

lParam

呼叫端提供的值，用來做為 pfnPropSheetUI 函式的輸入自變數。 這個值可以是指針。

pResult

呼叫端提供的 DWORD 指標，可接收 pfnPropSheetUI 函式的最終傳回狀態。 如果 為 NULL，則不會傳回最終傳回狀態。 如需詳細資訊，請參閱接下來的＜備註＞一節。

傳回值

CommonPropertySheetUI 函式會傳回下列其中一個值：

傳回碼 Description
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 一節中的 CPSUI。

CommonPropertySheetUI 函式實際上會呼叫 pfnPropSheetUI 回呼數次，並在回呼的 PROPSHEETUI_INFO 結構中指定不同的 Reason 成員值。 每次回呼傳回時，都會將結果狀態放在PROPSHEETUI_INFO結構的 Result 成員中。 CommonPropertySheetUI 函式傳回時，會將 Result 的最終內容複製到 pResult 指向的位置。

規格需求

需求 值
目標平台 桌面
標頭 compstui.h (包含 Compstui.h)