PlusleSeedCalculator.Library.IUtil インターフェース
これはプラスルツールのプラグイン作者向けに書かれた記事です。
プラグインの使い方を知りたい方は[id:plusletool:20100918:howtouse]を参照。
プラグインの作り方を知りたい方は[id:plusletool:20100918:PluginManual]も参照。
iniファイルの読み書きに必要になりそうなメソッドを提供するユーティリティインターフェースです。
このインターフェースを実装したインスタンスは、IPlugin インターフェースのInitializePluginメソッドおよびFinalizePluginメソッドの引数として、プラスルツール本体側から提供されます。
よってプラグイン作者はこのインターフェースを実装する必要はありません。
GetIniSections メソッド
iniファイルに含まれるセクション名をすべて取得します。
ただし、合計(MAX-セクション数)文字までしか取得できません。
（現バージョンではMAXの値は1024ですが、今後変更する可能性もあります。）
【定義】
IEnumerable<string> GetIniSections();
【戻り値】
iniファイルに含まれるセクション名のコレクション。
GetIniKeys メソッド
指定したセクションに含まれるキー名をすべて取得します。
ただし、合計(MAX-キー数)文字までしか取得できません。
（現バージョンではMAXの値は1024ですが、今後変更する可能性もあります。）
【定義】
IEnumerable<string> GetIniKeys( string section );
【パラメータ】
- section
- セクション名
【戻り値】
指定したセクションに含まれるキー名のコレクション。
GetIniValue メソッド
指定したセクションとキーからiniファイルの設定値を取得します。
このメソッドには２個のオーバーロードがあります。
【定義１】
string GetIniValue( string section, string key );
【パラメータ】
- section
- セクション名
- key
- キー名
【戻り値】
セクションとキーの組み合わせに対応するiniファイルの設定値。
セクションとキーの組み合わせがない場合、string.Emptyが返ります。
----------------
【定義２】
string GetIniValue( string section, string key, string defaultValue );
【パラメータ】
- section
- セクション名
- key
- キー名
- defaultValue
- デフォルト値
【戻り値】
セクションとキーの組み合わせに対応するiniファイルの設定値。
セクションとキーの組み合わせがない場合、defaultValueが返ります。
SetIniValue メソッド
指定したセクションとキーに値を設定します。
【定義】
void SetIniValue( string section, string key, string value );
【パラメータ】
- section
- セクション名
- key
- キー名
- value
- 値
ClearIniKey メソッド
指定したセクションとキーの組み合わせを削除します。
【定義】
void ClearIniKey( string section, string key );
【パラメータ】
- section
- セクション名
- key
- キー名
ClearIniSection メソッド
指定したセクションを削除します。
セクション内に含まれるキーもすべて削除されます。
【定義】
void ClearIniSection( string section );
【パラメータ】
- section
- セクション名
ClearIniAll メソッド
iniファイル内のすべてのセクション、キーを削除します。
【定義】
void ClearIniAll();
