PFNPROPSHEETUI コールバック関数 (compstui.h)

  • [アーティクル]

PFNPROPSHEETUI 関数の種類は、ページ 作成コールバックを定義するために CPSUI アプリケーション (プリンター インターフェイス DLL を含む) によって使用されます。これにより、作成するプロパティ シート ページが指定されます。

構文

PFNPROPSHEETUI Pfnpropsheetui;

LONG Pfnpropsheetui(
  PPROPSHEETUI_INFO pPSUIInfo,
  LPARAM lParam
)
{...}

パラメーター

pPSUIInfo

PROPSHEETUI_INFO構造体への CPSUI 提供のポインター。

lParam

PROPSHEETUI_INFO構造体の Reason メンバーの内容に依存する CPSUI 提供の整数値。 有効な値は次のとおりです。

PROPSHEETUI_REASON_BEFORE_INIT

この値はWindows 8の新しい値であり、CommonPropertySheetUI に渡された元の PFNPROPSHEETUI パラメーターにのみ指定されます。

PROPSHEETUI_REASON_DESTROY

ユーザーがプロパティ シートの [OK] または [キャンセル] ボタンを選択した場合、lParam 値は 0 以外です。 それ以外の場合、値は 0 です。

PROPSHEETUI_REASON_GET_ICON

lParam 値は、PROPSHEETUI_GETICON_INFO構造体へのポインターです。

PROPSHEETUI_REASON_GET_INFO_HEADER

lParam 値は、PROPSHEETUI_INFO_HEADER構造体へのポインターです。

PROPSHEETUI_REASON_INIT

コールバック関数が、commonPropertySheetUI に対する pfnPropSheetUI パラメーターで指定されている場合、lParam は CommonPropertySheetUI に渡される lParam 値です。

コールバック関数が CPSUI の ComPropSheet 関数と共にCPSFUNC_ADD_PFNPROPSHEETUI関数コードを使用して指定されている場合、lParam は ComPropSheet に渡される lParam2 値です。

CPSUI は、関数の PROPSHEETUI_INFO 構造体の lParamInit メンバーに lParam 値をコピーします。

lParam 値は、アプリケーションのスタック上に存在してはなりません。

PROPSHEETUI_REASON_SET_RESULT

lParam 値は、SETRESULT_INFO構造体へのポインターです。

戻り値

操作が成功した場合、関数は 1 つ以上の値を返す必要があります。 それ以外の場合は、1 未満の値を返す必要があります。

リターン コード 説明
1 つ以上。 現在のページの親に関連付けられている PFNPROPSHEETUI 関数が呼び出されます。
1 未満。 現在のページの親に関連付けられている PFNPROPSHEETUI 関数は呼び出されません。

注釈

PFNPROPSHEETUI 関数の種類を使用して指定されたコールバック関数は、 CPSUI を使用してカスタマイズされたプロパティ シート ページを管理するアプリケーションによって提供されます。 アプリケーションが CommonPropertySheetUI 関数を呼び出すときに、このようなコールバック関数を 1 つ指定する必要があります。 たとえば、NT ベースのオペレーティング システムの印刷スプーラーが CPSUI の CommonPropertySheetUI 関数を呼び出して DocumentProperties 関数または PrinterProperties 関数をサポートする場合、スプーラーは PFNPROPSHEETUI 型の内部コールバック関数を指定します。

アプリケーションでは、CPSFUNC_ADD_PFNPROPSHEETUIの関数コードを使用して CPSUI の ComPropSheet 関数を呼び出すことによって、追加のPFNPROPSHEETUI 型のコールバック関数を指定できます。 たとえば、NT ベースのオペレーティング システムの印刷スプーラーは、プリンター インターフェイス DLL の DrvDocumentPropertySheets 関数と DrvDevicePropertySheets 関数の存在を CPSUI に通知するためにこれを行います。 同様に、Microsoft の Unidrv ドライバーと Pscript ドライバーは、この手法を使用して、ユーザー インターフェイス プラグインに IPrintOemUI::D ocumentPropertySheets メソッドと IPrintOemUI::D evicePropertySheets メソッドが存在することを CPSUI に通知します。

各 PFNPROPSHEETUI 型のコールバック関数は、CPSUI によって複数回呼び出されます。 PROPSHEETUI_INFO構造体の Reason メンバーは、関数が実行する必要がある操作を次のように指定します。

要件

要件 値
対象プラットフォーム デスクトップ
Header compstui.h (Compstui.h を含む)