SetupCopyErrorA 関数 (setupapi.h)

[アーティクル]
11/20/2024

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

SetupCopyError 関数は、ファイルのコピーエラーをユーザーに通知するダイアログボックスを生成します。

構文

WINSETUPAPI UINT SetupCopyErrorA(
  [in]      HWND   hwndParent,
  [in]      PCSTR  DialogTitle,
  [in]      PCSTR  DiskName,
  [in]      PCSTR  PathToSource,
  [in]      PCSTR  SourceFile,
  [in]      PCSTR  TargetPathFile,
  [out]     UINT   Win32ErrorCode,
  [in]      DWORD  Style,
  [in, out] PSTR   PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

パラメーター

[in] hwndParent

このダイアログボックスの親ウィンドウへのハンドル。

[in] DialogTitle

ダイアログボックスのタイトルを指定する -terminated 文字列null への省略可能なポインター。

このパラメーターは NULLできます。このパラメーターが NULL場合は、既定のタイトル "Copy Error" (システム言語にローカライズ) が使用されます。

[in] DiskName

挿入するディスクの名前を指定する -terminated 文字列null への省略可能なポインター。

このパラメーターは NULLできます。このパラメーターが NULL場合は、既定の名前 "(Unknown)" (システム言語にローカライズ) が使用されます。

[in] PathToSource

操作が失敗するソースファイルのパスコンポーネントへのポインター (F:\x86 など)。

null-terminated 文字列を使用します。

[in] SourceFile

null-terminated 文字列へのポインター。操作が失敗したファイルのファイル名部分を指定します。

null-terminated 文字列を使用します。このファイル名は、ユーザーが [の詳細] をクリックするか、[参照] ボタン表示されます。 SetupCopyError 関数は、圧縮されたフォーム名を使用するファイルを検索します。したがって、cmd.exe を渡すことができます。また、ファイルがソースメディアにcmd.ex_として実際に存在することを心配する必要はありません。

[in] TargetPathFile

名前変更およびコピー操作の対象ファイルの完全なパスを指定する、null終了文字列への省略可能なポインター。

null-terminated 文字列を使用します。このパラメーターは NULLできます。 TargetPathFile が指定されていない場合は、"(不明)" (システム言語にローカライズ) が使用されます。

[out] Win32ErrorCode

エラーが発生した場合、このメンバーはシステムエラーコードです。

エラーが発生しない場合は、NO_ERROR。

[in] Style

ダイアログボックスの書式設定と動作を制御するフラグ。

このパラメーターには、次のいずれかのフラグを指定できます。

IDF_NOBROWSE

参照オプションを表示しません。

IDF_NOSKIP

[ファイルのスキップ] オプションは表示しないでください。

IDF_NODETAILS

詳細オプションは表示しません。

このフラグを設定すると、TargetPathFile および Win32ErrorCode パラメーター省略できます。

IDF_NOCOMPRESSED

ソースファイルの圧縮バージョンを確認しないでください。

IDF_OEMDISK

操作ソースは、ハードウェアの製造元が提供するディスクです。

IDF_NOBEEP

ダイアログボックスが最初に表示されたときに、ユーザーの注意を引くためにビープ音を鳴らさないようにします。

IDF_NOFOREGROUND

ダイアログボックスがフォアグラウンドウィンドウにならないようにします。

IDF_WARNIFSKIP

ファイルをスキップするとインストールに影響を与える可能性があることをユーザーに警告します。

[in, out] PathBuffer

この関数がダイアログボックスでユーザーが指定した場所のパス (ファイル名を含まない) を返す変数への省略可能なポインター。 null で終わる文字列を使用する必要があります。

null-terminated 文字列は、宛先バッファーのサイズを超えないようにする必要があります。バッファーエラーが不足しないようにするには、PathBuffer 少なくともMAX_PATHする必要があります。詳細については、このトピックの「解説」セクションを参照してください。

[in] PathBufferSize

PathBuffer が指バッファーのサイズ (文字単位)。

バッファーサイズは、null ターミネータを含め、少なくともMAX_PATH文字にする必要があります。

[in, out] PathRequiredSize

この関数が必要なバッファーサイズ (null ターミネータを含む) を文字で返す変数への省略可能なポインター。

戻り値

この関数は、次のいずれかの値を返します。

拡張エラー情報を取得するには、GetLastError呼び出します。

備考

この関数が、NULL の PathBuffer で呼び出され、PathBufferSize が 0 (ゼロ) の場合、指定されたデータを保持するために必要なバッファーサイズが、PathRequiredSizeによって指される変数に格納されます。

関数が成功した場合、戻り値はNO_ERROR。それ以外の場合、戻り値は指定された値のいずれかになります。

バッファーエラーが不足しないようにするには、ReturnBuffer 少なくともMAX_PATHする必要があります。

手記

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

必要条件

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

次の方法で共有