SetupGetLineTextW 関数 (setupapi.h)

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

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

SetupGetLineText 関数は、INF ファイル内の行の内容をコンパクトな形式で返します。取得する行は、SetupFindLineXXX 関数から返される INFCONTEXT 構造体、または目的の行の INF ハンドル、セクション、およびキーを明示的に渡すことによって指定できます。

構文

WINSETUPAPI BOOL SetupGetLineTextW(
  [in]      PINFCONTEXT Context,
  [in]      HINF        InfHandle,
  [in]      PCWSTR      Section,
  [in]      PCWSTR      Key,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

パラメーター

[in] Context

テキストを取得する INF ファイル内の行のコンテキスト。このパラメーターは NULLできます。コンテキストが NULL場合は、InfHandle、セクション、およびキーをすべて指定する必要があります。

[in] InfHandle

クエリを実行する INF ファイルを処理します。このパラメーターは NULLできます。このパラメーターは、コンテキストが NULL場合にのみ使用されます。コンテキストが NULL場合は、InfHandle、セクション、およびキーをすべて指定する必要があります。

[in] Section

テキストを取得する行のキー名を含むセクションを指定する、null終了文字列へのポインター。このパラメーターは NULLできます。このパラメーターは、コンテキストが NULL場合にのみ使用されます。コンテキストが NULL場合は、InfHandle、Section、および Key を指定する必要があります。

[in] Key

関連付けられた文字列を取得するキー名を含む null-terminated 文字列へのポインター。このパラメーターは NULLできます。このパラメーターは、コンテキストが NULL場合にのみ使用されます。コンテキストが NULL場合は、InfHandle、Section、および Key を指定する必要があります。

[in, out] ReturnBuffer

NULLしない場合、ReturnBuffer は、この関数が行の内容を返すバッファーを指します。 null-terminated 文字列は、宛先バッファーのサイズを超えてはなりません。関数を 1 回呼び出して、必要なバッファーサイズを取得し、必要なメモリを割り当ててから、もう一度関数を呼び出してデータを取得できます。この手法を使用すると、バッファーサイズが不十分なため、エラーを回避できます。「解説」セクションを参照してください。このパラメーターは NULLできます。

[in] ReturnBufferSize

ReturnBuffer パラメーターが指すバッファーのサイズ (文字数)。これには、null ターミネータが含まれます。

[in, out] RequiredSize

NULLしない場合、この関数は、ReturnBuffer パラメーターが指すバッファーに必要なサイズを文字で返す変数を指します。これには、null ターミネータが含まれます。 ReturnBuffer を指定し、必要なサイズが ReturnBufferSize パラメーターで指定された値より大きい場合、関数は失敗し、バッファーにデータを格納しません。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError呼び出します。

備考

この関数が null の ReturnBuffer で呼び出され、ReturnBufferSize が 0 の場合、指定されたデータを保持するために必要なバッファーサイズ RequiredSizeによって指される変数に格納されます。この関数が成功した場合、戻り値は 0 以外の値になります。それ以外の場合、戻り値は 0 で、GetLastError呼び出すことによって拡張エラー情報を取得できます。

この関数は、行の内容をコンパクトな形式で返します。余分な空白がすべて削除され、複数行の値が 1 つの連続した文字列に変換されます。たとえば、次の行があります。

HKLM, , PointerClass0, 1 \
; This is a comment
01, 02, 03

は次のように返されます。

HKLM,,PointerClass0,1,01,02,03

注意

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

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows Server 2003 [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	setupapi.h
ライブラリ	Setupapi.lib
DLL	Setupapi.dll
API セットの	ext-ms-win-setupapi-inf-l1-1-0 (Windows 8 で導入)

次の方法で共有

SetupGetLineTextW 関数 (setupapi.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース