共用方式為

COMPROPSHEETUI 結構 （compstui.h）

  • 發行項

如果函式程式代碼是 CPSFUNC_ADD_PCOMPROPSHEETUI，COMPROPSHEETUI 結構會作為 CPSUI ComPropSheet 函式的輸入參數。 所有結構成員都必須由 comPropSheet 呼叫者提供。

語法

typedef struct _COMPROPSHEETUI {
  WORD           cbSize;
  WORD           Flags;
  HINSTANCE      hInstCaller;
  LPTSTR         pCallerName;
  ULONG_PTR      UserData;
  LPTSTR         pHelpFile;
  _CPSUICALLBACK pfnCallBack;
  POPTITEM       pOptItem;
  PDLGPAGE       pDlgPage;
  WORD           cOptItem;
  WORD           cDlgPage;
  ULONG_PTR      IconID;
  LPTSTR         pOptItemName;
  WORD           CallerVersion;
  WORD           OptItemVersion;
  ULONG_PTR      dwReserved[4];
} COMPROPSHEETUI, *PCOMPROPSHEETUI;

成員

cbSize

COMPROPSHEETUI 結構的呼叫端提供大小，以位元組為單位。

Flags

選擇性呼叫端提供的位旗標，如下列清單所述：

CPSUIF_ABOUT_CALLBACK

如果設定，頁面的回呼函式（由結構的 pfnCallback 成員所指向），支援CPSUICB_REASON_ABOUT，因此如果使用者按兩下頁面的 [About] 按鈕，CPSUI 會呼叫回呼函式。 （CPSUI 會為每個樹視圖根節點提供 About 按鈕。

CPSUIF_ICONID_AS_HICON

如果設定，結構的 IconID 成員包含圖示句柄。

如果未設定，IconID 成員包含圖示資源識別符。

CPSUIF_UPDATE_PERMISSION

如果設定，使用者可以修改頁面的選項值。

hInstCaller

呼叫端提供的模組實例句柄，由 DLL 的進入點函式接收。

pCallerName

呼叫端提供的指標，指向代表應用程式名稱的NULL終止文字字串。 （針對印表機介面 DLL，這應該是驅動程式的名稱，例如 “PostScript Driver”。

UserData

選擇性的呼叫端提供值，CPSUI 會在呼叫 pfnCallBack 所指向的函式時，CPSUICBPARAM 結構的 UserData 成員中放置。

pHelpFile

呼叫端提供的指標，指向NULL終止的文字字串，代表說明檔的路徑。 針對印表機介面 DLL，這通常是呼叫 getPrinterDriver 取得的說明檔路徑。

說明檔是由 HelpIndex 成員 OPTITEM 結構中包含的值所編製索引。

pfnCallBack

呼叫端提供的 _CPSUICALLBACK型回呼函式指標，當使用者修改頁面的選項值時，CPSUI 會呼叫該函式。

只有當 pDlgPage 識別 CPSUI 提供的 DLGPAGE 結構，或 DlgProc 應用程式提供的 DLGPAGE 結構成員 NULL時，才能使用。

pOptItem

呼叫端提供的指標 OPTITEM 陣列， 描述頁面選項的結構。

pDlgPage

此成員會指定要加入至屬性表的 DLGPAGE 結構。 它可以是下列其中一項：

  • DLGPAGE 結構的陣列指標。

  • 下列清單中的其中一個指標。 這些指標會參考 CPSUI 提供的預先定義 DLGPAGE 結構，以供印表機介面 DLL 使用。

    • CPSUI_PDLGPAGE_ADVDOCPROP

      定義樹檢視頁面，其索引標籤會讀取 進階。 僅適用於 DrvDocumentPropertySheets 函式。

    • CPSUI_PDLGPAGE_DOCPROP

      定義三個頁面，其索引標籤 版面配置、紙張/品質，以及 進階。 [進階] 頁面是樹視圖。 僅適用於 DrvDocumentPropertySheets 函式。

    • CPSUI_PDLGPAGE_PRINTERPROP

      定義樹檢視頁面，其索引標籤會讀取 [裝置設定]。 僅適用於 DrvDevicePropertySheets 函式。

    • CPSUI_PDLGPAGE_TREEVIEWONLY

      定義一個樹視圖頁面。

cOptItem

呼叫端提供的 OPTITEM 結構 數目，pOptItem所指向。

cDlgPage

呼叫端提供的 DLGPAGE 結構 數目 pDlgPage所指向。 如果 pDlgPage 指定預先定義的CPSUI_PDLGPAGE前置結構，則不會使用 。

IconID

呼叫端提供，可以是下列其中一項：

  • 圖示資源標識碼。 這可以是應用程式定義的，也可以是其中一個 CPSUI 提供且前置IDI_CPSUI圖標資源識別碼。

  • 圖示句柄。 如果指定句柄，則必須在 旗標 成員中設定CPSUIF_ICONID_AS_HICON。

指定的圖示會顯示在屬性表頁面樹檢視的根節點中。

pOptItemName

要顯示在屬性表頁面樹視圖根節點中之 NULL 終止字串的呼叫端指標。 對於印表機介面 DLL，此字串通常代表印表機裝置類型，例如 「HP 4si」。

CallerVersion

呼叫端提供的版本號碼，代表呼叫端應用程式的目前版本。 高位元節會識別主要版本，而低位元組則是次要版本。 例如，CallerVersion 值0x310指定呼叫端版本號碼 3.16。 當使用者按下頁面的 [關於] 按鈕時，會顯示版本號碼。

OptItemVersion

呼叫端提供的版本號碼，代表根層級選項專案的目前版本。 對於印表機介面 DLL，這通常代表印表機裝置版本。 高位元節會識別主要版本，而低位元組則是次要版本。 例如，OptItemVersion 值0x3ff指定呼叫端版本號碼 3.255。 當使用者按下頁面的 [關於] 按鈕時，會顯示版本號碼。

dwReserved[4]

保留。 這個陣列必須設定為零。

要求

要求 價值
標頭 compstui.h （包括 Compstui.h）