SetupInstallFileW 関数 (setupapi.h)

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

SetupInstallFile 関数は、SetupFindXXXLine によって返される INFCONTEXT またはファイル名とパスによって明示的に指定されたファイルをインストールします。

ファイルがコピーされる場合、この関数の呼び出し元には、ターゲット ディレクトリへの書き込み特権が必要です。

構文

WINSETUPAPI BOOL SetupInstallFileW(
  [in] HINF                InfHandle,
  [in] PINFCONTEXT         InfContext,
  [in] PCWSTR              SourceFile,
  [in] PCWSTR              SourcePathRoot,
  [in] PCWSTR              DestinationName,
  [in] DWORD               CopyStyle,
  [in] PSP_FILE_CALLBACK_W CopyMsgHandler,
  [in] PVOID               Context
);

パラメーター

[in] InfHandle

SourceDisksNames セクションと SourceDisksFiles セクションを含む INF ファイルへのハンドルへの省略可能なポインター。 ユーザーのシステムにプラットフォーム固有のセクション (SourceDisksNames.x86 や SourceDisksFiles.x86 など) が存在する場合は、プラットフォーム固有のセクションが使用されます。 InfContext が null で、CopyStyle にSP_COPY_SOURCE_ABSOLUTEまたはSP_COPY_SOURCEPATH_ABSOLUTEが含まれている場合、InfHandle は無視されます。

[in] InfContext

INF ファイルの [ファイルのコピー] セクション内の行のコンテキストへの省略可能なポインター。 このルーチンは、InfHandle の SourceDisksFiles セクションでこのファイル を検索して、ファイル コピー情報を取得します。 InfHandle 指定されていない場合は、SourceFile する必要があります。

[in] SourceFile

コピーするファイルのファイル名 (パスなし) への省略可能なポインター。 ファイルは SourceDisksFiles セクションで検索されます。 InfContext が指定されていない場合は、SourceFile パラメーター 指定する必要があります。 InfContext が指定されている場合 SourceFile は無視されます。

[in] SourcePathRoot

コピーするファイルのルート パスへの省略可能なポインター (A:\ や F: など)。 SourceDisksNames セクションのパスがこのパスに追加されます。 copyStyle に SP_COPY_SOURCE_ABSOLUTE フラグが含まれている場合、SourcePathRoot パラメーター 無視されます。

[in] DestinationName

ターゲット ファイルのファイル名のみ (パスなし) への省略可能なポインター。 ターゲット ファイルの名前がソース ファイルと同じである必要があることを示すには、このパラメーターを null にできます。 InfContext 指定されていない場合は、DestinationName ターゲットの完全なパスとファイル名を指定します。

[in] CopyStyle

ファイル コピー操作の動作を制御するフラグ。 これらのフラグは、次の値の組み合わせである場合があります。

価値 意味
SP_COPY_DELETESOURCE
コピーが正常に完了したら、ソース ファイルを削除します。 削除操作が失敗した場合、呼び出し元には通知されません。
SP_COPY_REPLACEONLY
コピー先のパスにあるファイルが上書きされる場合にのみ、ファイルをコピーします。 ターゲットが存在しない場合、関数は FALSE 返し、GetLastError NO_ERRORを返します。
SP_COPY_NEWER_OR_SAME
コピーされる各ファイルを調べて、そのバージョン リソースがターゲット上の既存のコピーと同じバージョンか新しくないかを示しているかどうかを確認します。

バージョン チェック時に使用されるファイル バージョン情報は、バージョン関数によって入力された dwFileVersionMS および dwFileVersionLSVS_FIXEDFILEINFO 構造体のメンバーで指定されます。 いずれかのファイルにバージョン リソースがない場合、または同じバージョン情報がある場合、ソース ファイルは新しいと見なされます。

ソース ファイルが新しくないか、バージョンが等しくなく、CopyMsgHandler が指定されている場合、呼び出し元に通知され、コピー操作を取り消すことができます。 CopyMsgHandler が指定されていない場合、ファイルはコピーされません。

SP_COPY_NEWER_ONLY
コピーされる各ファイルを調べて、そのバージョン リソースがターゲット上の既存のコピーよりも新しくないことを示しているかどうかを確認します。 ソース ファイルが新しいが、既存のターゲットとバージョンが等しくない場合は、ファイルがコピーされます。
SP_COPY_NOOVERWRITE
ターゲット ファイルが存在するかどうかを確認し、存在する場合は、コピーを拒否する可能性がある呼び出し元に通知します。 CopyMsgHandler が指定されていない場合、ファイルは上書きされません。
SP_COPY_NODECOMP
ファイルを展開しないでください。 このフラグが設定されている場合、ターゲット ファイルにはソース名の圧縮されていない形式が指定されません (該当する場合)。 たとえば、F:\x86\cmd.ex_ を \\ にコピー\temp をインストールすると、\\install\temp\cmd.ex_のターゲット ファイルになります。 SP_COPY_NODECOMP フラグが指定されていない場合、ファイルは展開され、ターゲットは \\install\temp\cmd.exeと呼ばれます。 DestinationNameのファイル名部分 (指定されている場合) は削除され、ソース ファイルのファイル名に置き換えられます。 SP_COPY_NODECOMPを指定すると、言語やバージョン情報を確認できません。
SP_COPY_LANGUAGEAWARE
コピーされる各ファイルを調べて、その言語がターゲット上の既存のファイルの言語と異なるかどうかを確認します。 その場合、CopyMsgHandler 指定すると、呼び出し元に通知され、コピーを取り消すことができます。 CopyMsgHandler が指定されていない場合、ファイルはコピーされません。
SP_COPY_SOURCE_ABSOLUTE
SourceFile は完全なソース パスです。 INF ファイルの SourceDisksNames セクションで検索しないでください。
SP_COPY_SOURCEPATH_ABSOLUTE
SourcePathRoot は、ソース ファイルの完全なパス部分です。 ファイルが配置されているソース メディアの INF ファイルの SourceDisksNames セクションで指定された相対ソースを無視します。 SP_COPY_SOURCE_ABSOLUTEが指定されている場合、このフラグは無視されます。
SP_COPY_FORCE_IN_USE
ターゲットが存在する場合は、使用中と同じように動作し、次回のシステム再起動時にコピー用にファイルをキューに入れます。
SP_COPY_FORCE_NOOVERWRITE
ターゲット ファイルが存在するかどうかを確認し、存在する場合はファイルが上書きされません。 呼び出し元には通知されません。
SP_COPY_FORCE_NEWER
コピーされる各ファイルを調べて、そのバージョン リソース (またはイメージ以外のファイルのタイム スタンプ) が、ターゲット上の既存のコピーよりも新しくないかどうかを確認します。 コピーされるファイルが新しくない場合、ファイルはコピーされません。 呼び出し元には通知されません。 この関数は FALSE返し、GetLastError はNO_ERRORを返します。

[in] CopyMsgHandler

ファイルコピー操作中に発生する可能性のあるさまざまな条件を通知するコールバック関数へのオプションのポインター。

[in] Context

コールバック関数の最初のパラメーターとして渡される呼び出し元定義値へのオプションのポインター。

戻り値

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

関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError呼び出します。

GetLastError NO_ERRORが返された場合、ファイルのコピー操作は完了していません。 ファイルのコピー操作が不要であったか、ファイル コールバック関数が FALSE返されたため、ファイルがコピーされていない可能性があります。

備考

UNC ディレクトリがファイル インストールのターゲット ディレクトリとして指定されている場合は、SetupInstallFile呼び出す前に、そのディレクトリが存在することを確認する必要があります。 セットアップ関数は、UNC ディレクトリの存在を確認したり、作成したりしません。 ターゲット UNC ディレクトリが存在しない場合、ファイルのインストールは失敗します。

注意

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP [デスクトップ アプリのみ]
サポートされる最小サーバー Windows Server 2003 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー setupapi.h
ライブラリ Setupapi.lib
DLL Setupapi.dll

関連項目

Functions

の概要

SetupCloseFileQueue の

SetupCommitFileQueue の

SetupOpenFileQueue

SetupQueueCopy の