COMPROPSHEETUI 構造体 (compstui.h)

[アーティクル]
02/22/2024

関数コードが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をサポートするため、ユーザーがページの [バージョン情報 ] ボタンをクリックすると CPSUI によってコールバック関数が呼び出されます。 (CPSUI では、ツリービューのルートノードごとに [バージョン 情報] ボタンが提供されます)。

CPSUIF_ICONID_AS_HICON

設定した場合、構造体の IconID メンバーにはアイコンハンドルが含まれます。

設定されていない場合、 IconID メンバーにはアイコンリソース識別子が含まれます。

CPSUIF_UPDATE_PERMISSION

設定した場合、ページのオプション値はユーザーが変更できます。

hInstCaller

DLL のエントリポイント関数によって受け取られた、呼び出し元から提供されたモジュールインスタンスハンドル。

pCallerName

アプリケーションの名前を表す NULL で終わるテキスト文字列への呼び出し元指定のポインター。 (プリンターインターフェイス DLL の場合は、"PostScript ドライバー" などのドライバーの名前にする必要があります)。

UserData

オプションの呼び出し元指定値。CPSUI は、pfnCallBack が指す関数を呼び出すときに CPSUICBPARAM 構造体の UserData メンバーに配置します。

pHelpFile

ヘルプファイルへのパスを表す NULL で終わるテキスト文字列への呼び出し元指定ポインター。プリンターインターフェイス DLL の場合、これは通常、 GetPrinterDriver を呼び出すことによって取得されるヘルプファイルパスです。

ヘルプファイルのインデックスは、OPTITEM 構造体の HelpIndex メンバーに含まれる値によって作成されます。

pfnCallBack

ユーザーがページのオプション値を変更したときに CPSUI によって呼び出される、 _CPSUICALLBACK型指定のコールバック関数への呼び出し元指定ポインター。

pDlgPage が CPSUI 提供の DLGPAGE 構造体を識別する場合、またはアプリケーション提供の DLGPAGE 構造体の DlgProc メンバーが NULL の場合にのみ使用できます。

pOptItem

ページのオプションを記述する OPTITEM 構造体の配列への呼び出し元指定ポインター。

pDlgPage

このメンバーは、プロパティシートに追加するページを記述する DLGPAGE 構造体を指定します。次のいずれかを指定できます。

DLGPAGE 構造体の配列へのポインター。
次の一覧で説明するポインターの 1 つ。これらのポインターは、プリンターインターフェイス DLL で使用するために CPSUI によって提供される定義済みの DLGPAGE 構造体を参照します。
- CPSUI_PDLGPAGE_ADVDOCPROP
  
  タブが [詳細設定] と読み上げられる 1 つのツリービューページを定義します。 DrvDocumentPropertySheets 関数でのみ使用します。
- CPSUI_PDLGPAGE_DOCPROP
  
  [ レイアウト]、[ 用紙/品質]、[ 詳細設定] の 3 つのページを定義します。 [詳細設定] ページはツリービューです。 DrvDocumentPropertySheets 関数でのみ使用します。
- CPSUI_PDLGPAGE_PRINTERPROP
  
  タブが [ デバイス設定] と読み上げられる 1 つのツリービューページを定義します。 DrvDevicePropertySheets 関数でのみ使用します。
- CPSUI_PDLGPAGE_TREEVIEWONLY
  
  1 つのツリービューページを定義します。

cOptItem

pOptItem が指す OPTITEM 構造体の呼び出し元から指定された数。

cDlgPage

pDlgPage が指す DLGPAGE 構造体の呼び出し元から指定された数。 pDlgPage で定義済みのCPSUI_PDLGPAGEプレフィックス付き構造体が指定されている場合は使用されません。

IconID

呼び出し元から提供されるには、次のいずれかを指定できます。

アイコンリソース識別子。これは、アプリケーション定義でも、CPSUI 提供のIDI_CPSUIプレフィックス付きアイコンリソース識別子の 1 つでもかまいません。
アイコンハンドル。ハンドルが指定されている場合は、 CPSUIF_ICONID_AS_HICON Flags メンバーで設定する必要があります。

プロパティシートページのツリービューのルートノードに、指定したアイコンが表示されます。

pOptItemName

プロパティシートページのツリービューのルートノードに表示される NULL で終わる文字列への呼び出し元指定のポインター。プリンターインターフェイス DLL の場合、この文字列は通常、"HP 4si" などのプリンターデバイスの種類を表します。

CallerVersion

呼び出し元が指定したバージョン番号。呼び出し元のアプリケーションの現在のバージョンを表します。上位バイトはメジャーバージョンを識別し、下位バイトはマイナーバージョンです。たとえば、0x310 の CallerVersion 値は、呼び出し元のバージョン番号 3.16 を指定します。バージョン番号は、ユーザーがページの [バージョン 情報] ボタンをクリックすると表示されます。

OptItemVersion

ルートレベルのオプション項目の現在のバージョンを表す、呼び出し元から指定されたバージョン番号。プリンターインターフェイス DLL の場合、これは通常、プリンターデバイスのバージョンを表します。上位バイトはメジャーバージョンを識別し、下位バイトはマイナーバージョンです。たとえば、 0x3ff の OptItemVersion 値は、呼び出し元のバージョン番号 3.255 を指定します。バージョン番号は、ユーザーがページの [バージョン 情報] ボタンをクリックすると表示されます。

dwReserved[4]

予約済み。この配列は 0 に設定する必要があります。

要件

要件	値
Header	compstui.h (Compstui.h を含む)

次の方法で共有

COMPROPSHEETUI 構造体 (compstui.h)

構文

メンバー

CPSUIF_ABOUT_CALLBACK

CPSUIF_ICONID_AS_HICON

CPSUIF_UPDATE_PERMISSION

要件

フィードバック

その他のリソース