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