SetupDefaultQueueCallbackW 関数 (setupapi.h)

  • [アーティクル]

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

SetupDefaultQueueCallback 関数は、セットアップ API に含まれる既定のキュー コールバック ルーチンです。 これを使用して、 SetupCommitFileQueue 関数によって送信された通知を処理できます。

構文

WINSETUPAPI UINT SetupDefaultQueueCallbackW(
  [in] PVOID    Context,
  [in] UINT     Notification,
  [in] UINT_PTR Param1,
  [in] UINT_PTR Param2
);

パラメーター

[in] Context

SetupInitDefaultQueueCallback 関数または SetupInitDefaultQueueCallbackEx 関数によって初期化されたコンテキストへのポインター。

[in] Notification

キュー アクションの通知。 このパラメーターには次の表に示すいずれかの値を指定できます。

値 説明
SPFILENOTIFY_STARTQUEUE
 キューに登録されたファイル操作を開始しました。
SPFILENOTIFY_ENDQUEUE
 キューに登録されたファイル操作が完了しました。
SPFILENOTIFY_STARTSUBQUEUE
 サブキューのコピー、名前変更、または削除を開始しました。
SPFILENOTIFY_ENDSUBQUEUE
 サブキューのコピー、名前変更、または削除が完了しました。
SPFILENOTIFY_STARTRENAME
 名前変更操作を開始しました。
SPFILENOTIFY_ENDRENAME
 名前の変更操作を完了しました。
SPFILENOTIFY_RENAMEERROR
 ファイルの名前変更中にエラーが発生しました。
SPFILENOTIFY_STARTDELETE
 削除操作を開始しました。
SPFILENOTIFY_ENDDELETE
 削除操作を完了しました。
SPFILENOTIFY_DELETEERROR
 ファイルの削除中にエラーが発生しました。
SPFILENOTIFY_STARTCOPY
 コピー操作を開始しました。
SPFILENOTIFY_ENDCOPY
 コピー操作を完了しました。
SPFILENOTIFY_COPYERROR
 ファイルのコピー中にエラーが発生しました。
SPFILENOTIFY_NEEDMEDIA
 新しいメディアが必要です。
SPFILENOTIFY_LANGMISMATCH
 既存のターゲット ファイルは、ソースとは異なる言語です。
SPFILENOTIFY_TARGETEXISTS
 ターゲット ファイルが存在します。
SPFILENOTIFY_TARGETNEWER
既存のターゲット ファイルがソースより新しい。

[in] Param1

追加のメッセージ情報。 このパラメーターの内容は、 Notification パラメーターの値によって異なります。

[in] Param2

追加のメッセージ情報。 このパラメーターの内容は、 Notification パラメーターの値によって異なります。

戻り値

次の表に示す値のいずれかである、符号なし整数を SetupCommitFileQueue に返します。

リターン コード 説明
FILEOP_ABORT
 操作を中止します。
FILEOP_DOIT
 ファイル操作を実行します。
FILEOP_SKIP
 操作をスキップします。
FILEOP_RETRY
 操作を再試行します。
FILEOP_NEWPATH
 操作の新しいパスを取得します。
 

詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

SetupDefaultQueueCallback 関数は、通常、カスタム キュー コールバック ルーチンによってのみ明示的に呼び出されます。 カスタム コールバックは、キュー コミット通知のサブセットを処理し、 SetupDefaultQueueCallback 関数を呼び出して、残りの通知を処理します。

詳細については、「 キュー通知」を参照してください。

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDefaultQueueCallback を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー setupapi.h
Library Setupapi.lib
[DLL] Setupapi.dll
API セット ext-ms-win-setupapi-classinstallers-l1-1-2 (Windows 10 バージョン 10.0.14393 で導入)

関連項目

関数

概要

SetupCommitFileQueue