GetPrivateProfileStringW

GetPrivateProfileStringW (Unicode) 関数 (winbase.h) は、初期化ファイルの指定セクションから文字列を取得する。

GetPrivateProfileStringW lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName

lpAppName : [wstr] キー名を含むセクションの名前。このパラメータが NULL の場合、GetPrivateProfileString 関数はファイル内のすべてのセクション名を指定バッファにコピーする。
lpKeyName : [wstr] 関連付けられた文字列を取得するキーの名前。このパラメータが NULL の場合、lpAppName パラメータで指定したセクション内のすべてのキー名が lpReturnedString パラメータで指定したバッファにコピーされる。
lpDefault : [wstr] 既定の文字列。lpKeyName キーが初期化ファイル内に見つからない場合、GetPrivateProfileString は既定の文字列を lpReturnedString バッファにコピーする。
lpReturnedString : [wstr] 取得した文字列を受け取るバッファへのポインタ。
nSize : [int] lpReturnedString パラメータが指すバッファのサイズ(文字数)。
lpFileName : [wstr] 初期化ファイルの名前。このパラメータがファイルへのフルパスを含まない場合、システムは Windows ディレクトリ内でファイルを検索する。

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

解説

GetPrivateProfileStringW (Unicode) 関数 (winbase.h)
は、初期化ファイルの指定セクションから文字列を取得する。

[戻り値]
戻り値は、バッファにコピーされた文字数(終端 null 文字を除く)。lpAppName と lpKeyName のいずれも NULL
でなく、指定された宛先バッファが要求された文字列を保持するには小さすぎる場合、文字列は切り詰められて null 文字が続き、戻り値は
nSize から 1 を引いた値に等しい。lpAppName または lpKeyName のいずれかが NULL
で、指定された宛先バッファがすべての文字列を保持するには小さすぎる場合、最後の文字列は切り詰められて 2 つの null
文字が続く。この場合、戻り値は nSize から 2 を引いた値に等しい。lpFileName
で指定された初期化ファイルが見つからない、または無効な値を含む場合、この関数は errorno を '0x2' (File Not
Found) の値に設定する。拡張エラー情報を取得するには GetLastError を呼ぶ。

[備考]
GetPrivateProfileString 関数は、lpAppName パラメータで指定したセクション見出しの下で lpKeyName
パラメータで指定した名前と一致するキーを、指定した初期化ファイルから検索する。キーが見つかると、関数は対応する文字列をバッファにコピーする。キーが存在しない場合、関数は
lpDefault パラメータで指定した既定文字列をコピーする。初期化ファイル内のセクションは以下の形式でなければならない。
(以下省略)

情報

プラグイン / モジュール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