GetProfileStringW

Win.ini ファイルの指定セクション内のキーに関連付けられた文字列を取得する。(Unicode)

GetProfileStringW lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize

lpAppName : [wstr] キーを含むセクションの名前。このパラメータが NULL の場合、関数はファイル内のすべてのセクション名を指定バッファにコピーする。
lpKeyName : [wstr] 関連付けられた文字列を取得するキーの名前。このパラメータが NULL の場合、関数は指定セクション内のすべてのキーを指定バッファにコピーする。各文字列の後には null 文字が続き、最後の文字列の後にはさらに null 文字が続く。
lpDefault : [wstr] 既定の文字列。lpKeyName キーが初期化ファイル内に見つからない場合、GetProfileString は既定の文字列を lpReturnedString バッファにコピーする。このパラメータが NULL の場合、既定値は空文字列 "" となる。
lpReturnedString : [wstr] 文字列を受け取るバッファへのポインタ。
nSize : [int] lpReturnedString パラメータが指すバッファのサイズ(文字数)。

(プラグイン / モジュール : kernel32.dll)

解説

Win.ini ファイルの指定セクション内のキーに関連付けられた文字列を取得する。(Unicode)

[戻り値]
戻り値は、バッファにコピーされた文字数(終端 null 文字を除く)。lpAppName と lpKeyName のいずれも NULL
でなく、指定された宛先バッファが要求された文字列を保持するには小さすぎる場合、文字列は切り詰められて null 文字が続き、戻り値は
nSize から 1 を引いた値に等しい。lpAppName または lpKeyName のいずれかが NULL
で、指定された宛先バッファがすべての文字列を保持するには小さすぎる場合、最後の文字列は切り詰められて 2 つの null
文字が続く。この場合、戻り値は nSize から 2 を引いた値に等しい。

[備考]
lpKeyName パラメータに関連付けられた文字列が単一引用符または二重引用符で囲まれている場合、GetProfileString
関数が文字列を返すときに引用符は破棄される。GetProfileString
関数は大文字と小文字を区別しない。文字列は大文字と小文字の組み合わせを含むことができる。Win.ini
ファイル内のセクションは以下の形式でなければならない。
(以下省略)

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs