SetupGetSourceFileLocationA 関数 (setupapi.h)
[この機能は、[要件] セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、Windows インストーラーを使用してアプリケーション インストーラーを開発します。 SetupAPI は、引き続きデバイス ドライバーのインストールに使用されます。
SetupGetSourceFileLocation 関数は、INF ファイルに一覧表示されているソース ファイルの場所を取得します。
構文
WINSETUPAPI BOOL SetupGetSourceFileLocationA(
[in] HINF InfHandle,
[in] PINFCONTEXT InfContext,
[in] PCSTR FileName,
[in, out] PUINT SourceId,
[in, out] PSTR ReturnBuffer,
[out] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
パラメーター
[in] InfHandle
SourceDisksNames セクションと SourceDisksFiles セクションを含む INF ファイルを処理します。 ユーザーのシステムにプラットフォーム固有のセクションが存在する場合 ( SourceDisksNames.x86 や SourceDisksFiles.x86 など)、プラットフォーム固有のセクションが使用されます。
[in] InfContext
完全なソース パスを取得するファイルの コピー セクション内の行のコンテキストへのオプションのポインター。 このパラメーターが NULL の場合、FileName は InfHandle で指定された INF ファイルの SourceDisksFiles セクションで検索されます。
[in] FileName
完全なソースの場所を返すファイル名 (パスなし) を含む null で終わる文字列への省略可能なポインター。 このパラメーターには NULL を指定できますが、 FileName または InfContext を指定する必要があります。
[in, out] SourceId
INF ファイルの SourceDisksNames セクションからファイルが配置されているメディアのソース識別子を受け取る変数へのポインター。
[in, out] ReturnBuffer
相対ソース パスを受け取るバッファーへの省略可能なポインター。 ソース パスにはファイル名自体は含まれません。また、ドライブ文字/ネットワーク共有名も含まれません。 パスは円記号 () で開始または終了しないため、空の文字列はルート ディレクトリを指定します。 null で終わる文字列バッファーを使用する必要があります。 null で終わる文字列は、コピー先バッファーのサイズを超えないようにする必要があります。 関数を 1 回呼び出して、必要なバッファー サイズを取得し、必要なメモリを割り当ててから、もう一度関数を呼び出してデータを取得できます。 この手法を使用すると、バッファー サイズが不十分なため、エラーを回避できます。 「解説」を参照してください。 このパラメーターは、NULL でもかまいません。
[out] ReturnBufferSize
ReturnBuffer が指すバッファーのサイズ (文字数)。 この数値には null 終端記号が含まれます。
[in, out] RequiredSize
ReturnBuffer パラメーターが指すバッファーに必要なサイズを受け取る変数への省略可能なポインター (文字数)。 この数値には null 終端記号が含まれます。 必要なサイズが ReturnBufferSize で指定された値より大きい場合、関数は失敗し、 GetLastError は ERROR_INSUFFICIENT_BUFFERを返します。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
ReturnBuffer が NULL で ReturnBufferSize が 0 の場合、この関数は、指定されたデータを保持するために必要なバッファー サイズを RequiredSize が指す変数に格納します。 この関数が成功した場合、戻り値は 0 以外の値になります。 それ以外の場合、戻り値は 0 で、 GetLastError を呼び出すことで拡張エラー情報を取得できます。
注意
setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupGetSourceFileLocation を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | setupapi.h |
| Library | Setupapi.lib |
| [DLL] | Setupapi.dll |