LPSETUPHOOKPROC コールバック関数 (commdlg.h)

[アーティクル]
08/22/2023

PrintDlg 関数で使用されるアプリケーション定義またはライブラリ定義のコールバック関数。フックプロシージャは、[ 印刷設定] ダイアログボックスの既定のダイアログボックスプロシージャを対象としたメッセージまたは通知を受け取ります。

LPSETUPHOOKPROC 型は、このコールバック関数へのポインターを定義します。 SetupHookProc は、アプリケーション定義またはライブラリ定義関数名のプレースホルダーです。

構文

LPSETUPHOOKPROC Lpsetuphookproc;

UINT_PTR Lpsetuphookproc(
  HWND unnamedParam1,
  UINT unnamedParam2,
  WPARAM unnamedParam3,
  LPARAM unnamedParam4
)
{...}

パラメーター

unnamedParam1

メッセージが意図されている [ 印刷設定 ] ダイアログボックスのハンドル。

unnamedParam2

受信するメッセージの識別子。

unnamedParam3

メッセージについての追加情報。正確な意味は、 名前のないParam2 パラメーターの値によって異なります。

unnamedParam4

メッセージについての追加情報。正確な意味は、 名前のないParam2 パラメーターの値によって異なります。

戻り値

フックプロシージャから 0 が返された場合、既定のダイアログボックスプロシージャによってメッセージが処理されます。

フックプロシージャが 0 以外の値を返す場合、既定のダイアログボックスプロシージャはメッセージを無視します。

注釈

[ 印刷設定] ダイアログボックスは、[ ページ設定 ] ダイアログボックスに置き換えられます。このダイアログボックスは、新しいアプリケーションで使用する必要があります。ただし、互換性のために、 PrintDlg 関数は、[ 印刷設定 ] ダイアログボックスの表示を引き続きサポートします。 [印刷設定] ダイアログボックスの SetupHookProc フックプロシージャを指定して、ダイアログボックスプロシージャを対象としたメッセージまたは通知を処理できます。

フックプロシージャを有効にするには、ダイアログ作成関数に渡した PRINTDLG 構造体を使用します。 lpfnSetupHook メンバーでフックプロシージャのアドレスを指定し、Flags メンバーで PD_ENABLESETUPHOOK フラグを指定します。

既定のダイアログボックスプロシージャは、 WM_INITDIALOG メッセージをフックプロシージャに渡す前に処理します。その他のすべてのメッセージについて、フックプロシージャは最初にメッセージを受け取ります。次に、フックプロシージャの戻り値によって、既定のダイアログプロシージャがメッセージを処理するか、無視するかを決定します。

フックプロシージャが WM_CTLCOLORDLG メッセージを処理する場合は、ダイアログボックスの背景を描画するための有効なブラシハンドルを返す必要があります。一般に、フックプロシージャが WM_CTLCOLOR* メッセージを処理する場合は、指定したコントロールの背景を描画するために有効なブラシハンドルを返す必要があります。

フックプロシージャから EndDialog 関数を呼び出さないでください。代わりに、フックプロシージャは PostMessage 関数を呼び出して、IDABORT 値を含むWM_COMMAND メッセージをダイアログボックスプロシージャに投稿できます。 IDABORT を投稿すると、ダイアログボックスが閉じ、ダイアログボックス関数が FALSE を返します。フックプロシージャがダイアログボックスを閉じた理由を知る必要がある場合は、フックプロシージャとアプリケーションの間に独自の通信メカニズムを提供する必要があります。

共通ダイアログボックスの標準コントロールをサブクラス化できます。ただし、ダイアログボックスプロシージャでは、コントロールをサブクラス化することもできます。このため、フックプロシージャが WM_INITDIALOG メッセージを処理するときに、コントロールをサブクラス化する必要があります。これにより、サブクラスプロシージャは、ダイアログボックスプロシージャによって設定されたサブクラスプロシージャの前に、コントロール固有のメッセージを受け取ります。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	commdlg.h (Windows.h を含む)