CommonPropertySheetUIW 関数 (compstui.h)

  • [アーティクル]

CPSUI の CommonPropertySheetUI 関数は、プロパティ シート ページを表示し、表示される値をユーザーが変更できるようにします。

構文

LONG CommonPropertySheetUIW(
  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 ベースのオペレーティング システム印刷スプーラーなど) は、 関数を呼び出して、定義済みの親ウィンドウに 1 つ以上のプロパティ シート ページを追加できます。 CPSUI はページを表示し、ユーザーがページを変更できるようにし、コールバック関数を介してユーザー アクティビティをアプリケーションに通知します。

Win32 アプリケーションがスプーラーの DocumentProperties 関数または PrinterProperties 関数を呼び出すと、NT ベースのオペレーティング システムの印刷スプーラーは CommonPropertySheetUI 関数 を 呼び出します。

pfnPropSheetUI パラメーターで指定されたコールバック関数は、追加するプロパティ シート ページを記述します。 詳細については、 PFNPROPSHEETUI 関数の種類の説明を参照してください。

操作のシーケンスは次のとおりです。

  1. CommonPropertySheetUI 関数は pfnPropSheetUI コールバックを呼び出して、CPSUI の ComPropSheet 関数を呼び出して追加するページをコールバックで記述できるようにします。

  2. pfnPropSheetUI コールバックが成功した場合、CommonPropertySheetUI 関数は新しいプロパティ シート ページを表示し、ユーザーがページ値を変更できるようにします。

  3. ユーザーがページ値を変更すると、 ページ イベント コールバック によって変更がアプリケーションに通知されます。

  4. ユーザーが [OK] または [キャンセル ] ボタンを選択すると、 CommonPropertySheetUI 関数は表示されているページを破棄して返します。

操作のシーケンスの詳細については、「CPSUI」セクションの「プリンター ドライバーでの CPSUI の使用」を参照してください。

CommonPropertySheetUI 関数は、実際には pfnPropSheetUI コールバックを複数回呼び出し、コールバックの PROPSHEETUI_INFO 構造体に異なる Reason メンバー値を指定します。 コールバックが返されるたびに、結果の状態がPROPSHEETUI_INFO構造体の Result メンバーに配置されます。 CommonPropertySheetUI 関数は、戻るときに、Result の最終的な内容を pResult が指す場所にコピーします。

要件

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