SetupInitDefaultQueueCallbackEx 関数 (setupapi.h)

[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]

SetupInitDefaultQueueCallbackEx 関数は、SetupInitDefaultQueueCallback と同じ方法でセットアップ API に含まれる既定のキュー コールバック ルーチンで使用されるコンテキストを初期化します。ただし、進行状況メッセージを受け入れるための追加ウィンドウがコールバック関数に提供される点が除きます。

構文

WINSETUPAPI PVOID SetupInitDefaultQueueCallbackEx(
  [in] HWND  OwnerWindow,
  [in] HWND  AlternateProgressWindow,
  [in] UINT  ProgressMessage,
  [in] DWORD Reserved1,
  [in] PVOID Reserved2
);

パラメーター

[in] OwnerWindow

既定のコールバック ルーチンによって生成されたダイアログ ボックスの親として使用するウィンドウを処理します。

[in] AlternateProgressWindow

進行状況メッセージを受信するウィンドウを処理します。 進行状況メッセージが表示されないようにするには、このパラメーターをINVALID_HANDLE_VALUEに指定します。

[in] ProgressMessage

コピー キューが開始され、ファイルがコピーされるたびに AlternateProgressWindow に送信されるメッセージ。

[in] Reserved1

既定のコールバック ルーチンによって AlternateProgressWindow に送信される最初のメッセージ パラメーター。

[in] Reserved2

既定のコールバック ルーチンによって AlternateProgressWindow に送信される 2 番目のメッセージ パラメーター。

戻り値

SetupInitDefaultQueueCallbackEx は、既定のキュー コールバック ルーチンで使用されるコンテキストへのポインターを返します。 この関数は、メモリが不足している場合にのみ失敗します。 この関数が失敗した場合、 NULL が 返され、スレッドの最後のエラー コードは設定されません。

解説

キューがコピー サブキューのコミットを開始すると、既定のキュー コールバック ルーチンは 、AlternateProgressWindow で指定されたウィンドウにメッセージを送信します。 Reserved1 の値は 0 で、 Reserved2 にはエンキューされたファイル コピー操作の数へのポインターが含まれています。

完了したファイルのコピー操作ごとに、既定のキュー コールバック ルーチンは AlternateProgressWindow にメッセージを送信します。これを使用すると、進行状況バーを "ティック" できます。 Reserved1 の値は 1 で、 予約済み 2 は 0 です。

SetupInitDefaultQueueCallbackEx を使用すると、ディスクプロンプトやエラー処理などの既定の動作を取得したり、ウィザード ページやその他の特殊なダイアログ ボックスにゲージを埋め込んだりすることもできます。

SetupInitDefaultQueueCallback または SetupInitDefaultQueueCallbackEx を使用して既定のキュー コールバック ルーチンで使用されるコンテキストを初期化したかどうかにかかわらず、キュー操作の処理が完了したら、SetupTermDefaultQueueCallback を呼び出して、コンテキスト構造の初期化に割り当てられたリソースを解放します。 詳細については、「 コールバック コンテキストの初期化と終了」を参照してください。

要件

関連項目

関数

概要

SetupInitDefaultQueueCallback