SetupPromptForDiskW 関数 (setupapi.h)

[アーティクル]
08/26/2023

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

SetupPromptForDisk 関数は、ユーザーにディスクの入力を求めるダイアログボックスを表示します。

構文

WINSETUPAPI UINT SetupPromptForDiskW(
  [in]      HWND   hwndParent,
  [in]      PCWSTR DialogTitle,
  [in]      PCWSTR DiskName,
  [in]      PCWSTR PathToSource,
  [in]      PCWSTR FileSought,
  [in]      PCWSTR TagFile,
  [in]      DWORD  DiskPromptStyle,
  [in, out] PWSTR  PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

パラメーター

[in] hwndParent

このダイアログボックスの親ウィンドウを処理します。

[in] DialogTitle

ダイアログタイトルを指定する null で終わる文字列への省略可能なポインター。このパラメーターが NULL の場合、既定値の ""%s--Files Needed"" (ローカライズ済み) が使用されます。 "%s" は、親ウィンドウから取得したテキストに置き換えられます。親ウィンドウからテキストが取得されない場合、タイトルは "Files Needed" になります。

[in] DiskName

挿入するディスクの名前を指定する null で終わる文字列への省略可能なポインター。このパラメーターが NULL の場合、既定の "(Unknown)" (ローカライズ済み) が使用されます。

[in] PathToSource

F:\x86 など、ファイルの予想される場所のパス部分を指定する null で終わる文字列への省略可能なポインター。指定しない場合は、 SetupPromptForDisk が最後にファイルを配置したパスが使用されます。そのリストが空の場合は、システムの既定値が使用されます。

[in] FileSought

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

[in] TagFile

特定のリムーバブルメディアボリュームの存在を識別するタグファイル (ファイル名部分のみ) を指定する null で終わる文字列へのオプションのポインター。現在選択されているパスでファイルがリムーバブルメディアに配置され、タグファイルが指定されている場合、 SetupPromptForDisk はドライブのルートにあるタグファイルを検索して、続行するかどうかを決定します。

たとえば、 PathToSource が A:\x86 の場合、タグファイルは disk1.tag で、ユーザーはプロンプトダイアログボックスの編集コントロールに「B:\x86」と入力すると、ルーチンは B:\disk1.tag を探して続行するかどうかを判断します。タグファイルが見つからない場合、関数は PathToSource を使用してタグファイルを検索します。

タグファイルが指定されていない場合、リムーバブルメディアは非リムーバブルメディアと同様に機能し、続行する前に FileSought が検索されます。

[in] DiskPromptStyle

ダイアログボックスの動作を指定します。このパラメーターには、次のフラグの組み合わせを指定できます。

IDF_CHECKFIRST

プロンプトダイアログボックスを表示する前にファイル/ディスクを確認し、存在する場合はすぐにDPROMPT_SUCCESS返します。

IDF_NOBEEP

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

IDF_NOBROWSE

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

IDF_NOCOMPRESSED

ソースファイルの圧縮バージョンにはチェックしないでください。

IDF_NODETAILS

詳細情報を表示しません。

IDF_NOFOREGROUND

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

IDF_NOSKIP

スキップオプションは表示しないでください。

IDF_OEMDISK

ハードウェアの製造元から提供されたディスクの入力を求めるメッセージが表示されます。

IDF_WARNIFSKIP

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

[in, out] PathBuffer

返されると、ダイアログボックスを通じてユーザーが指定した場所のパス (ファイル名なし) を受け取るバッファーへの省略可能なポインター。 null で終わる文字列を使用する必要があります。 null で終わる文字列は、コピー先バッファーのサイズを超えないようにする必要があります。関数を 1 回呼び出して、必要なバッファーサイズを取得し、必要なメモリを割り当ててから、もう一度関数を呼び出してデータを取得できます。この手法を使用すると、バッファーサイズが不十分なため、エラーを回避できます。「解説」を参照してください。

[in] PathBufferSize

PathBuffer が指すバッファーのサイズ (文字数)。少なくともMAX_PATH長くする必要があります。これには null 終端記号が含まれます。

[in, out] PathRequiredSize

PathBuffer に必要なサイズを受け取る変数への省略可能なポインター (文字数)。これには null 終端記号が含まれます。

戻り値

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

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

解説

この関数が PathBuffer の NULL と PathBufferSize が 0 の場合、指定されたデータを保持するために必要なバッファーサイズが PathRequiredSize によって指される変数に格納されます。この関数が成功した場合、戻り値はNO_ERROR。それ以外の場合、戻り値は「戻り値」セクションで説明されている値のいずれかです。

注意

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

要件


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