次の方法で共有

CommonPropertySheetUIA 関数 (compstui.h)

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

構文

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

パラメーター

hWndOwner

呼び出し元が指定したウィンドウ ハンドル。新しいプロパティ シート ページを配置するウィンドウを識別します。

pfnPropSheetUI

PFNPROPSHEETUI-typed コールバック関数への呼び出し元指定ポインター。

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が指す場所にコピーします。

必要条件

要件 価値
ターゲット プラットフォーム の デスクトップ
ヘッダー compstui.h (Compstui.h を含む)