SetupCopyErrorW 関数 (setupapi.h)

[アーティクル]
03/05/2024

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

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

構文

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

パラメーター

[in] hwndParent

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

[in] DialogTitle

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

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

[in] DiskName

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

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

[in] PathToSource

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

null で終わる文字列を使用します。

[in] SourceFile

操作が失敗するファイルのファイル名部分を指定する null で終わる文字列へのポインター。

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

[in] TargetPathFile

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

null で終わる文字列を使用します。このパラメーターは、NULL でもかまいません。 TargetPathFile が指定されていない場合は、"(Unknown)" (システム言語にローカライズ) が使用されます。

[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 で終わる文字列は、宛先バッファーのサイズを超えてはなりません。バッファーエラーが不十分にならないように、 PathBuffer は少なくともMAX_PATHする必要があります。詳細については、このトピックの「解説」セクションを参照してください。

[in] PathBufferSize

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

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

[in, out] PathRequiredSize

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

戻り値

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

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

解説

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

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

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

注意

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

要件

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