INIファイルの読み書き
標準の.iniファイルを読み書きできるクラスが.NET Frameworkにありますか。
[Section]
<keyname>=<value>
...
DelphiにはTIniFileコンポーネントがあり、C＃に似たようなものがあるかどうか知りたいですか。
.NETフレームワークの作成者は、INIファイルではなくXMLベースの設定ファイルを使用したいと考えています。したがって、それらを読み取るための組み込みメカニズムはありません。
ただし、サードパーティの解決策があります。
- INIハンドラは、 INI Parser のように、 NuGetパッケージ として取得できます。
- あなたはあなた自身のINIハンドラを書くことができます。そしてそれは昔ながらの、面倒な方法です。それはあなたが悪いか良いかのために使うことができる実装をもっとコントロールすることを可能にします。例えば参照。 C＃、P/Invoke、およびWin32 を使用するINIファイル処理クラス。
序文
まず、このMSDNブログ投稿のINIファイルの制限を参照してください。それがあなたのニーズに合っているなら、読んでください。
これは私が書いた簡潔な実装で、オリジナルのWindows P/Invokeを利用しているので、.NETがインストールされているすべてのバージョンのWindows、つまりWindows 98 - Windows 10でサポートされています。私はここでそれをパブリックドメインにリリースします - あなたは帰属なしに商業的にそれを使用することができます。
小さなクラス
プロジェクトにIniFile.csという新しいクラスを追加します。
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
// Change this to match your program's normal namespace
namespace MyProg
{
class IniFile // revision 11
{
string Path;
string EXE = Assembly.GetExecutingAssembly().GetName().Name;
[DllImport("kernel32", CharSet = CharSet.Unicode)]
static extern long WritePrivateProfileString(string Section, string Key, string Value, string FilePath);
[DllImport("kernel32", CharSet = CharSet.Unicode)]
static extern int GetPrivateProfileString(string Section, string Key, string Default, StringBuilder RetVal, int Size, string FilePath);
public IniFile(string IniPath = null)
{
Path = new FileInfo(IniPath ?? EXE + ".ini").FullName.ToString();
}
public string Read(string Key, string Section = null)
{
var RetVal = new StringBuilder(255);
GetPrivateProfileString(Section ?? EXE, Key, "", RetVal, 255, Path);
return RetVal.ToString();
}
public void Write(string Key, string Value, string Section = null)
{
WritePrivateProfileString(Section ?? EXE, Key, Value, Path);
}
public void DeleteKey(string Key, string Section = null)
{
Write(Key, null, Section ?? EXE);
}
public void DeleteSection(string Section = null)
{
Write(null, null, Section ?? EXE);
}
public bool KeyExists(string Key, string Section = null)
{
return Read(Key, Section).Length > 0;
}
}
}
どうやって使うのですか
次の3つの方法のいずれかでINIファイルを開きます。
// Creates or loads an INI file in the same directory as your executable
// named EXE.ini (where EXE is the name of your executable)
var MyIni = new IniFile();
// Or specify a specific name in the current dir
var MyIni = new IniFile("Settings.ini");
// Or specify a specific name in a specific dir
var MyIni = new IniFile(@"C:\Settings.ini");
あなたはそのようないくつかの値を書くことができます：
MyIni.Write("DefaultVolume", "100");
MyIni.Write("HomePage", "http://www.google.com");
このようなファイルを作成するには
[MyProg]
DefaultVolume=100
HomePage=http://www.google.com
INIファイルから値を読み取るには、次のようにします。
var DefaultVolume = IniFile.Read("DefaultVolume");
var HomePage = IniFile.Read("HomePage");
必要に応じて、[Section]の値を設定できます。
MyIni.Write("DefaultVolume", "100", "Audio");
MyIni.Write("HomePage", "http://www.google.com", "Web");
このようなファイルを作成するには
[Audio]
DefaultVolume=100
[Web]
HomePage=http://www.google.com
キーの存在を確認することもできます。
if(!MyIni.KeyExists("DefaultVolume", "Audio"))
{
MyIni.Write("DefaultVolume", "100", "Audio");
}
あなたはそのようにキーを削除することができます：
MyIni.DeleteKey("DefaultVolume", "Audio");
次のようにセクション全体（すべてのキーを含む）を削除することもできます。
MyIni.DeleteSection("Web");
どんな改善でもコメントしてください！
CodeProjectに関するこの記事「 C＃を使ったINIファイル処理クラス "が参考になります。
作者はKERNEL32.dllから2つの機能を公開するC＃クラス "Ini"を作成しました。これらの関数はWritePrivateProfileStringとGetPrivateProfileStringです。 System.Runtime.InteropServicesとSystem.Textの2つの名前空間が必要です。
Iniクラスを使うための手順
プロジェクトの名前空間定義に以下を追加します。
using INI;
このようなINIFileを作成してください
INIFile ini = new INIFile("C:\\test.ini");
セクション内の特定のキーに新しい値を書き込むにはIniWriteValueを使用し、特定のセクション内のキーから値を読み取るにはIniReadValueを使用します。
注：最初から始める場合は、これを読むことができますMSDNの記事： 方法：アプリケーション構成ファイルを追加するC＃プロジェクトへ 。アプリケーションを構成するためのより良い方法です。
私はこの単純な実装を見つけました：
http://bytes.com/topic/net/insights/797169-reading-parsing-ini-file-c
私が必要としているものに対してうまく機能します。
使い方は次のとおりです。
public class TestParser
{
public static void Main()
{
IniParser parser = new IniParser(@"C:\test.ini");
String newMessage;
newMessage = parser.GetSetting("appsettings", "msgpart1");
newMessage += parser.GetSetting("appsettings", "msgpart2");
newMessage += parser.GetSetting("punctuation", "ex");
//Returns "Hello World!"
Console.WriteLine(newMessage);
Console.ReadLine();
}
}
これがコードです：
using System;
using System.IO;
using System.Collections;
public class IniParser
{
private Hashtable keyPairs = new Hashtable();
private String iniFilePath;
private struct SectionPair
{
public String Section;
public String Key;
}
/// <summary>
/// Opens the INI file at the given path and enumerates the values in the IniParser.
/// </summary>
/// <param name="iniPath">Full path to INI file.</param>
public IniParser(String iniPath)
{
TextReader iniFile = null;
String strLine = null;
String currentRoot = null;
String[] keyPair = null;
iniFilePath = iniPath;
if (File.Exists(iniPath))
{
try
{
iniFile = new StreamReader(iniPath);
strLine = iniFile.ReadLine();
while (strLine != null)
{
strLine = strLine.Trim().ToUpper();
if (strLine != "")
{
if (strLine.StartsWith("[") && strLine.EndsWith("]"))
{
currentRoot = strLine.Substring(1, strLine.Length - 2);
}
else
{
keyPair = strLine.Split(new char[] { '=' }, 2);
SectionPair sectionPair;
String value = null;
if (currentRoot == null)
currentRoot = "ROOT";
sectionPair.Section = currentRoot;
sectionPair.Key = keyPair[0];
if (keyPair.Length > 1)
value = keyPair[1];
keyPairs.Add(sectionPair, value);
}
}
strLine = iniFile.ReadLine();
}
}
catch (Exception ex)
{
throw ex;
}
finally
{
if (iniFile != null)
iniFile.Close();
}
}
else
throw new FileNotFoundException("Unable to locate " + iniPath);
}
/// <summary>
/// Returns the value for the given section, key pair.
/// </summary>
/// <param name="sectionName">Section name.</param>
/// <param name="settingName">Key name.</param>
public String GetSetting(String sectionName, String settingName)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
return (String)keyPairs[sectionPair];
}
/// <summary>
/// Enumerates all lines for given section.
/// </summary>
/// <param name="sectionName">Section to enum.</param>
public String[] EnumSection(String sectionName)
{
ArrayList tmpArray = new ArrayList();
foreach (SectionPair pair in keyPairs.Keys)
{
if (pair.Section == sectionName.ToUpper())
tmpArray.Add(pair.Key);
}
return (String[])tmpArray.ToArray(typeof(String));
}
/// <summary>
/// Adds or replaces a setting to the table to be saved.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
/// <param name="settingValue">Value of key.</param>
public void AddSetting(String sectionName, String settingName, String settingValue)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
if (keyPairs.ContainsKey(sectionPair))
keyPairs.Remove(sectionPair);
keyPairs.Add(sectionPair, settingValue);
}
/// <summary>
/// Adds or replaces a setting to the table to be saved with a null value.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
public void AddSetting(String sectionName, String settingName)
{
AddSetting(sectionName, settingName, null);
}
/// <summary>
/// Remove a setting.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
public void DeleteSetting(String sectionName, String settingName)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
if (keyPairs.ContainsKey(sectionPair))
keyPairs.Remove(sectionPair);
}
/// <summary>
/// Save settings to new file.
/// </summary>
/// <param name="newFilePath">New file path.</param>
public void SaveSettings(String newFilePath)
{
ArrayList sections = new ArrayList();
String tmpValue = "";
String strToSave = "";
foreach (SectionPair sectionPair in keyPairs.Keys)
{
if (!sections.Contains(sectionPair.Section))
sections.Add(sectionPair.Section);
}
foreach (String section in sections)
{
strToSave += ("[" + section + "]\r\n");
foreach (SectionPair sectionPair in keyPairs.Keys)
{
if (sectionPair.Section == section)
{
tmpValue = (String)keyPairs[sectionPair];
if (tmpValue != null)
tmpValue = "=" + tmpValue;
strToSave += (sectionPair.Key + tmpValue + "\r\n");
}
}
strToSave += "\r\n";
}
try
{
TextWriter tw = new StreamWriter(newFilePath);
tw.Write(strToSave);
tw.Close();
}
catch (Exception ex)
{
throw ex;
}
}
/// <summary>
/// Save settings back to ini file.
/// </summary>
public void SaveSettings()
{
SaveSettings(iniFilePath);
}
}
Joerageの答えの中のコードは刺激的です。
残念ながら、それはキーの文字の大文字小文字を変えてコメントを処理しません。だから私は非常に汚いINIファイルを読むためだけに十分頑強であるべきであり、そしてそれらがそのままキーを検索することを可能にする何かを書いた。
これは、セクション、キー、値を格納し、ファイルを一度に読み込むために、大文字と小文字を区別しない入れ子の文字列辞書であるLINQを使用します。
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
class IniReader
{
Dictionary<string, Dictionary<string, string>> ini = new Dictionary<string, Dictionary<string, string>>(StringComparer.InvariantCultureIgnoreCase);
public IniReader(string file)
{
var txt = File.ReadAllText(file);
Dictionary<string, string> currentSection = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
ini[""] = currentSection;
foreach(var line in txt.Split(new[]{"\n"}, StringSplitOptions.RemoveEmptyEntries)
.Where(t => !string.IsNullOrWhiteSpace(t))
.Select(t => t.Trim()))
{
if (line.StartsWith(";"))
continue;
if (line.StartsWith("[") && line.EndsWith("]"))
{
currentSection = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
ini[line.Substring(1, line.LastIndexOf("]") - 1)] = currentSection;
continue;
}
var idx = line.IndexOf("=");
if (idx == -1)
currentSection[line] = "";
else
currentSection[line.Substring(0, idx)] = line.Substring(idx + 1);
}
}
public string GetValue(string key)
{
return GetValue(key, "", "");
}
public string GetValue(string key, string section)
{
return GetValue(key, section, "");
}
public string GetValue(string key, string section, string @default)
{
if (!ini.ContainsKey(section))
return @default;
if (!ini[section].ContainsKey(key))
return @default;
return ini[section][key];
}
public string[] GetKeys(string section)
{
if (!ini.ContainsKey(section))
return new string[0];
return ini[section].Keys.ToArray();
}
public string[] GetSections()
{
return ini.Keys.Where(t => t != "").ToArray();
}
}
私は完全にc＃で作成したIniParserライブラリを導入したいので、Monoと互換性があるため、どのOSにも依存関係がありません。 MIT licenseを指定したオープンソースなので、どのコードでも使用できます。
あなたは GitHub でソースをチェックアウトすることができます、そしてそれは NuGetパッケージとしても利用可能です
恥知らずなプラグで申し訳ありませんが、私はそれがこの答えを再検討する誰かの助けになることを願っています。
私はパーティーに参加するのが遅いですが、私は今日同じ問題を抱えていて、私は以下の実装を書きました：
using System.Text.RegularExpressions;
static bool match(this string str, string pat, out Match m) =>
(m = Regex.Match(str, pat, RegexOptions.IgnoreCase)).Success;
static void Main()
{
Dictionary<string, Dictionary<string, string>> ini = new Dictionary<string, Dictionary<string, string>>();
string section = "";
foreach (string line in File.ReadAllLines(.........)) // read from file
{
string ln = (line.Contains('#') ? line.Remove(line.IndexOf('#')) : line).Trim();
if (ln.match(@"^[ \t]*\[(?<sec>[\w\-]+)\]", out Match m))
section = m.Groups["sec"].ToString();
else if (ln.match(@"^[ \t]*(?<prop>[\w\-]+)\=(?<val>.*)", out m))
{
if (!ini.ContainsKey(section))
ini[section] = new Dictionary<string, string>();
ini[section][m.Groups["prop"].ToString()] = m.Groups["val"].ToString();
}
}
// access the ini file as follows:
string content = ini["section"]["property"];
}
この実装は、見つからないセクションやプロパティを処理しないことに注意してください。これを実現するには、Dictionary<,>-クラスを拡張して、見つからないキーを処理するようにします。
Dictionary<string, Dictionary<string, string>>のインスタンスを.ini-ファイルにシリアル化するには、次のコードを使用します。
string targetpath = .........;
Dictionary<string, Dictionary<string, string>> ini = ........;
StringBuilder sb = new StringBuilder();
foreach (string section in ini.Keys)
{
sb.AppendLine($"[{section}]");
foreach (string property in ini[section].Keys)
sb.AppendLine($"{property}={ini[section][property]");
}
File.WriteAllText(targetpath, sb.ToString());
通常、C＃と.NETフレームワークを使用してアプリケーションを作成するときは、INIファイルを使用しません。 XMLベースの構成ファイルまたはレジストリに設定を保存するのが一般的です。ただし、ソフトウェアが従来のアプリケーションと設定を共有している場合は、他の場所に情報を複製するよりも、設定ファイルを使用する方が簡単な場合があります。
.NETフレームワークはINIファイルの直接使用をサポートしていません。ただし、Windows API関数をプラットフォーム呼び出しサービス（P/Invoke）と共に使用してファイルへの書き込みおよびファイルからの読み取りを行うことができます。このリンクでは、INIファイルを表すクラスを作成し、それらを操作するためにWindows API関数を使用します。次のリンクをたどってください。
CommonLibrary.NETで利用可能なIni Parserがあります
これはセクション/値を取得するためのさまざまな非常に便利なオーバーロードを持ち、非常に軽量です。
これが正規表現を使った私自身のバージョンです。このコードでは、各セクション名は一意であると想定しています。ただし、そうでない場合は、DictionaryをListに置き換えることは意味があります。この関数は、 ';'から始まる.iniファイルのコメントをサポートします。キャラクター。 sectionは通常[section]から始まり、キーと値のペアも通常 "key = value"になります。セクションと同じ仮定 - キー名は一意です。
/// <summary>
/// Loads .ini file into dictionary.
/// </summary>
public static Dictionary<String, Dictionary<String, String>> loadIni(String file)
{
Dictionary<String, Dictionary<String, String>> d = new Dictionary<string, Dictionary<string, string>>();
String ini = File.ReadAllText(file);
// Remove comments, preserve linefeeds, if end-user needs to count line number.
ini = Regex.Replace(ini, @"^\s*;.*$", "", RegexOptions.Multiline);
// Pick up all lines from first section to another section
foreach (Match m in Regex.Matches(ini, "(^|[\r\n])\\[([^\r\n]*)\\][\r\n]+(.*?)(\\[([^\r\n]*)\\][\r\n]+|$)", RegexOptions.Singleline))
{
String sectionName = m.Groups[2].Value;
Dictionary<String, String> lines = new Dictionary<String, String>();
// Pick up "key = value" kind of syntax.
foreach (Match l in Regex.Matches(ini, @"^\s*(.*?)\s*=\s*(.*?)\s*$", RegexOptions.Multiline))
{
String key = l.Groups[1].Value;
String value = l.Groups[2].Value;
// Open up quotation if any.
value = Regex.Replace(value, "^\"(.*)\"$", "$1");
if (!lines.ContainsKey(key))
lines[key] = value;
}
if (!d.ContainsKey(sectionName))
d[sectionName] = lines;
}
return d;
}
PeanutButter.INI はINIファイル操作のためのNugetパッケージのクラスです。それはコメントを含む読み書きをサポートします - あなたのコメントは書き込み時に保存されます。それはかなりポピュラーであるように見え、テストされそして使いやすいです。それはまた完全に無料でオープンソースです。
免責事項：私はPeanutButter.INIの作者です。
この方法を試してください。
public static Dictionary<string, string> ParseIniDataWithSections(string[] iniData)
{
var dict = new Dictionary<string, string>();
var rows = iniData.Where(t =>
!String.IsNullOrEmpty(t.Trim()) && !t.StartsWith(";") && (t.Contains('[') || t.Contains('=')));
if (rows == null || rows.Count() == 0) return dict;
string section = "";
foreach (string row in rows)
{
string rw = row.TrimStart();
if (rw.StartsWith("["))
section = rw.TrimStart('[').TrimEnd(']');
else
{
int index = rw.IndexOf('=');
dict[section + "-" + rw.Substring(0, index).Trim()] = rw.Substring(index+1).Trim().Trim('"');
}
}
return dict;
}
キーが " - "の辞書を作成します。あなたはこのようにそれをロードすることができます：
var dict = ParseIniDataWithSections(File.ReadAllLines(fileName));
セクションや他のDLLのない単純な読者が欲しい場合は、ここに簡単な解決策があります。
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Tool
{
public class Config
{
Dictionary <string, string> values;
public Config (string path)
{
values = File.ReadLines(path)
.Where(line => (!String.IsNullOrWhiteSpace(line) && !line.StartsWith("#")))
.Select(line => line.Split(new char[] { '=' }, 2, 0))
.ToDictionary(parts => parts[0].Trim(), parts => parts.Length>1?parts[1].Trim():null);
}
public string Value (string name, string value=null)
{
if (values!=null && values.ContainsKey(name))
{
return values[name];
}
return value;
}
}
}
使用例：
file = new Tool.Config (Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location) + "\\config.ini");
command = file.Value ("command");
action = file.Value ("action");
string value;
//second parameter is default value if no key found with this name
value = file.Value("debug","true");
this.debug = (value.ToLower()=="true" || value== "1");
value = file.Value("plain", "false");
this.plain = (value.ToLower() == "true" || value == "1");
その間、設定ファイルの内容（あなたが見ているように行コメントのための＃記号をサポートします）：
#command to run
command = php
#default script
action = index.php
#debug mode
#debug = true
#plain text mode
#plain = false
#icon = favico.ico
書き込みアクセスではなく読み取りアクセスのみが必要で、ASP.NET Coreにはデフォルトでバンドルされていますが、通常のプログラムでも機能するMicrosoft.Extensions.Confiurationを使用している場合は、NuGetパッケージを使用できます Microsoft.Extensions.Configuration.Iniあなたの設定にiniファイルをインポートする 。
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddIniFile("SomeConfig.ini", optional: false);
Configuration = builder.Build();
}
これが私のクラスで、魅力のように機能します：
public static class IniFileManager
{
[DllImport("kernel32")]
private static extern long WritePrivateProfileString(string section,
string key, string val, string filePath);
[DllImport("kernel32")]
private static extern int GetPrivateProfileString(string section,
string key, string def, StringBuilder retVal,
int size, string filePath);
[DllImport("kernel32.dll")]
private static extern int GetPrivateProfileSection(string lpAppName,
byte[] lpszReturnBuffer, int nSize, string lpFileName);
/// <summary>
/// Write Data to the INI File
/// </summary>
/// <PARAM name="Section"></PARAM>
/// Section name
/// <PARAM name="Key"></PARAM>
/// Key Name
/// <PARAM name="Value"></PARAM>
/// Value Name
public static void IniWriteValue(string sPath,string Section, string Key, string Value)
{
WritePrivateProfileString(Section, Key, Value, sPath);
}
/// <summary>
/// Read Data Value From the Ini File
/// </summary>
/// <PARAM name="Section"></PARAM>
/// <PARAM name="Key"></PARAM>
/// <PARAM name="Path"></PARAM>
/// <returns></returns>
public static string IniReadValue(string sPath,string Section, string Key)
{
StringBuilder temp = new StringBuilder(255);
int i = GetPrivateProfileString(Section, Key, "", temp,
255, sPath);
return temp.ToString();
}
}
静的クラスなので、セクションの読み取りにはIniFileManager.IniWriteValueを、セクションの読み取りにはIniFileManager.IniReadValueを呼び出すだけです。