SetupQueueCopyA 関数 (setupapi.h)

[アーティクル]
03/15/2023

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

SetupQueueCopy 関数は、セットアップファイルキューに 1 つのファイルコピー操作を追加します。

構文

WINSETUPAPI BOOL SetupQueueCopyA(
  [in] HSPFILEQ QueueHandle,
  [in] PCSTR    SourceRootPath,
  [in] PCSTR    SourcePath,
  [in] PCSTR    SourceFilename,
  [in] PCSTR    SourceDescription,
  [in] PCSTR    SourceTagfile,
  [in] PCSTR    TargetDirectory,
  [in] PCSTR    TargetFilename,
  [in] DWORD    CopyStyle
);

パラメーター

[in] QueueHandle

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

[in] SourceRootPath

このコピーのソースのルート (A: など) を指定する null で終わる文字列へのポインター。

[in] SourcePath

ファイルが見つかる SourceRootPath に対する相対パスを指定する null で終わる文字列へのポインター。このパラメーターは NULL である可能性があります。

[in] SourceFilename

コピーするファイルのファイル名部分を指定する null で終わる文字列へのポインター。

[in] SourceDescription

ディスクプロンプト中に使用するソースメディアの説明を指定する 、null で終わる文字列へのポインター。このパラメーターは、NULL でもかまいません。

[in] SourceTagfile

SourceRootPath でのプレゼンスがソースメディアの存在を示すタグファイルを指定する null で終わる文字列へのポインター。このパラメーターは NULL である可能性があります。指定しない場合、ファイル自体は、必要に応じてタグファイルとして使用されます。

[in] TargetDirectory

ファイルをコピーするディレクトリを指定する null で終わる文字列へのポインター。

[in] TargetFilename

ターゲットファイルの名前を指定する null で終わる文字列へのポインター。このパラメーターは NULL である可能性があります。指定しない場合、ターゲットファイルの名前はソースファイルと同じになります。

[in] CopyStyle

ファイルコピー操作の動作を指定します。このパラメーターは、次の値の組み合わせである場合があります。

SP_COPY_DELETESOURCE

コピーが正常に完了したら、ソースファイルを削除します。削除が失敗した場合、呼び出し元には通知されません。

SP_COPY_REPLACEONLY

コピー先のパスにあるファイルが上書きされる場合にのみ、ファイルをコピーします。呼び出し元には通知されません。

SP_COPY_NEWER_OR SAME

コピーされる各ファイルを調べて、そのバージョンリソースが、ターゲット上の既存のコピーと同じバージョンか新しくないかのどちらかであることを示しているかどうかを確認します。

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

ソースファイルがバージョン以降で等しくなく、 CopyMsgHandler が指定されている場合、呼び出し元に通知が送信され、コピーが取り消される可能性があります。 CopyMsgHandler が指定されていない場合、ファイルはコピーされません。

SP_COPY_NEWER_ONLY

コピーされる各ファイルを調べて、そのバージョンリソースがターゲット上の既存のコピーよりも新しくないことを示しているかどうかを確認します。ソースファイルが新しいが、既存のターゲットとバージョンが等しくない場合は、ファイルがコピーされます。

SP_COPY_NOOVERWRITE

ターゲットファイルが存在するかどうかを確認し、存在する場合は、コピーを拒否する可能性がある呼び出し元に通知します。 CopyMsgHandler が指定されていない場合、ファイルは上書きされません。

SP_COPY_NODECOMP

ファイルを展開しないでください。このフラグが設定されている場合、ターゲットファイルにはソース名の圧縮されていない形式が指定されません (該当する場合)。たとえば、f:\x86\cmd.ex_ を \install\temp にコピーすると、ターゲットファイルは \install\temp\cmd.ex_になります。 SP_COPY_NODECOMP フラグが指定されていない場合、ファイルは圧縮解除され、ターゲットは \install\temp\cmd.exe 呼び出されます。 DestinationName の filename 部分が指定されている場合、削除され、ソースファイルのファイル名に置き換えられます。 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_IN_USE_NEEDS_REBOOT

コピー操作中にファイルが使用されていた場合は、システムを再起動する必要があることをユーザーに警告します。

SP_COPY_NOSKIP

ファイルをスキップするオプションをユーザーに与えないでください。

SP_COPY_FORCE_NOOVERWRITE

ターゲットファイルが存在するかどうかを確認します。存在する場合は、ファイルは上書きされません。呼び出し元には通知されません。

SP_COPY_FORCE_NEWER

コピーされる各ファイルを調べて、そのバージョンリソース (またはイメージ以外のファイルのタイムスタンプ) が、ターゲット上の既存のコピーよりも新しくないことを示しているかどうかを確認します。コピーするファイルが新しくない場合、ファイルはコピーされません。呼び出し元には通知されません。

SP_COPY_WARNIFSKIP

ユーザーがファイルをスキップしようとすると、ファイルをスキップするとインストールに影響する可能性があることを警告します。 (システムクリティカルなファイルに使用されます)。

戻り値

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

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

解説

UNC ディレクトリがファイルコピー操作のターゲットディレクトリとして指定されている場合は、キューがコミットされる前に、UNC ディレクトリが存在することを確認する必要があります。セットアップ関数は、の存在をチェックせず、UNC ディレクトリを作成しません。ターゲット UNC ディレクトリが存在しない場合、ファイルのコピーは失敗します。

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	setupapi.h
Library	Setupapi.lib
[DLL]	Setupapi.dll

次の方法で共有