SetupCommitFileQueueW 関数 (setupapi.h)

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

SetupCommitFileQueue 関数は、セットアップ ファイル キューでキューに登録されたファイル操作を実行します。

ベスト プラクティスは、ファイル キューのコミット後にファイル キューを再利用できないため、ファイル キューに必要なすべてのファイル操作を収集し、キューを 1 回だけコミットすることです。 コミット後にキューの追加処理が必要な場合は、キューへのハンドルを閉じ、新しいファイル キューを作成する必要があります。 詳細については、「 キューのコミット」を参照してください。

ファイルが変更された場合、この関数の呼び出し元には、ターゲット ディレクトリに書き込む権限が必要です。

構文

WINSETUPAPI BOOL SetupCommitFileQueueW(
  [in] HWND                Owner,
  [in] HSPFILEQ            QueueHandle,
  [in] PSP_FILE_CALLBACK_W MsgHandler,
  [in] PVOID               Context
);

パラメーター

[in] Owner

進行状況ダイアログ ボックスの親として使用するウィンドウへの省略可能なハンドル。

[in] QueueHandle

SetupOpenFileQueue によって返されるセットアップ ファイル キューを処理します。

[in] MsgHandler

キュー処理中のさまざまな重要なイベントの通知を受け取るオプションのコールバック ルーチンへのポインター。 詳細については、「 既定のキュー コールバック ルーチン 」または「 FileCallback コールバック ルーチンが null の場合、 SetupCommitFileQueue は TRUE を 返し、エラーは 0 またはNO_ERROR」を参照してください。

[in] Context

MsgHandler パラメーターによって提供されるコールバック関数に渡される値。 既定のコールバック ルーチンが MsgHandler として指定されている場合、このコンテキストは SetupInitDefaultQueueCallback または SetupInitDefaultQueueCallbackEx から返されるコンテキストである必要があります。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

MsgHandler で指定されたコールバック ルーチンは、SetupCommitFileQueue がキューのコミット中に渡したパラメーターと互換性がある必要があります。

コールバック アプリケーションで Unicode が定義されていて、既定のキュー コールバック ルーチンとして MsgHandler を指定した場合、コールバック ルーチンには Unicode パラメーターが必要です。 それ以外の場合、既定のキュー コールバック ルーチンには ANSI パラメーターが必要です。

要件

関連項目

関数

概要

SetupCloseFileQueue