IniRead

標準フォーマットの.iniファイルから値、セクション、またはセクション名のリストを読み込みます。

Value := IniRead(Filename, Section, Key , Default)
Section := IniRead(Filename, Section ,, Default)
SectionNames := IniRead(Filename ,,, Default)

パラメータ

Filename

型：文字列

.iniファイルの名前。絶対パスが指定されていない場合は、A_WorkingDirにあると仮定されます。

Section

型：文字列

.iniファイル内のセクション名で、角括弧内に表示される見出し語です（このパラメータに括弧は含めないでください）。

Key

型：文字列

.iniファイル内のキー名です。

Default

型：文字列

省略したときは、失敗時にOSErrorがスローされます。そうでなければ、リクエストされたキー、セクション、またはファイルが見つからない場合など、失敗時に返す値を指定します。

戻り値

型：文字列

This function returns one of the following depending on the Key and Section parameters:

• If both parameters are specified, this function returns the actual value of the specified key.
• If Key is omitted, this function returns an entire section. コメントや空行は省略されます。セクションの最初の65,533文字のみが検索されます。
• If Key and Section are omitted, this function returns a linefeed (`n) delimited list of section names.

If none of these can be retrieved, the default value indicated by the Default parameter is returned.

エラー処理

Defaultが省略された場合のみ、失敗時にOSErrorが投げられます。

例外の発生有無にかかわらず、A_LastErrorにはオペレーティングシステムのGetLastError()関数の結果が設定されます。

備考

オペレーティングシステムは、取得した文字列から先頭と末尾のスペース/タブを自動的に省略します。これを防ぐには、文字列をシングルクォートまたはダブルクォートで囲んでください。最も外側にあるシングルクォートまたはダブルクォートのセットも省略されるが、クォートマーク内のスペースは保持されました。

65,535文字より長い値は、一貫性のない結果になる可能性が高いです。

標準的なiniファイルは次のようなものです：

[SectionName]
Key=Value

ユニコード：IniReadとIniWriteは、値の読み書きに外部関数GetPrivateProfileStringとWritePrivateProfileStringに依存しています。これらの関数は、UTF-16ファイルでのみUnicodeをサポートし、それ以外のファイルではシステムのデフォルトのANSIコードページを使用するものとします。

関連

IniDelete、IniWrite、RegRead、ファイル読み込みループ、FileRead

例

Value := IniRead("C:\Temp\myfile.ini", "section2", "key")
MsgBox "The value is " Value