SFXConfig

アプリの設定情報を保存するためのクラスです。

#include <SFXConfig.h.hpp>

class SFXConfig;

SFMTYPEDEFCLASS(SFXConfig)

協調図

解説

SFXConfig クラスは、『タグ』と『値』のペアからなるエントリの集合をファイルに保存するためのクラスです。

アプリの終了 / サスペンド時に、アプリの設定情報を『タグ』と『値』のペアからなるエントリとして SFXConfig クラスに設定しておけば、アプリの起動 / レジューム時にこのクラスからエントリを取得してアプリの設定情報を復元できます。

『タグ番号』には 0 から 65535 までの UInt16 型の数値、『値』には数値、文字列、またはバッファを指定できます。

	mif ファイルの設定
	`SFXConfig` クラスを利用するには、 mif ファイルの設定で「ファイル」の項目にチェックを入れる必要があります。

例 814. エントリの設定

SFXConfig config;

// エントリ（タグ番号: 1, "saving data") を SFXConfig に書き込む
config.WriteSFXAnsiString(1, "saving data");

//  SFXConfig の内容を "/data/applet.cfg" に保存する
config.Save(SFXPath("/data/applet.cfg"));

例 815. アプリの設定情報の読み込み

SFXConfig config;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("/data/applet.cfg"));

// 「タグ番号: 1」のエントリからの SFXAnsiString 型の値を取得する
// ※ 第 2 引数は、指定したタグ番号のエントリが存在しなかったときに返すデフォルト値
SFXAnsiString str = config.ReadSFXAnsiString(1, "default text");
// str ＝ "saving data"

例 816. 様々なデータ型のエントリの値

config.WriteSInt32(2, -17); // SInt32 型（タグ番号: 2）
config.WriteUInt08(3, 'a'); // UInt08 型（タグ番号: 3）
config.WriteBool(4, true);  // Bool 型  （タグ番号: 4）

ByteConst data[] = {0x01, 0x11, 0x22, 0x33, 0x44};
SFXBuffer buffer(data, lengthof(data));
config.WriteSFXBuffer(5, buffer);        // SFXBuffer 型（タグ番号: 5）

// SFXConfig インスタンス内の指定したタグ番号のエントリの値を読み込む
// ※ 第 2 引数は、指定したタグ番号のエントリが存在しなかったときに返すデフォルト値

SInt32 n1 = config.ReadSInt32(2, -9999); // SInt32 型（タグ番号: 2）
// n1 ＝ -17

AChar c = config.ReadUInt08(3, '\0');    // UInt08 型（タグ番号: 3）
// c ＝ 'a'

Bool b = config.ReadBool(4, false);      // Bool 型（タグ番号: 4）
// b ＝ true 

SFXBuffer buff = config.ReadSFXBuffer(5, SFXBuffer());  // SFXBuffer 型（タグ番号: 5）
// buff ＝ {0x01, 0x11, 0x22, 0x33, 0x44}

参照

SFXAnsiString | SFXWideString | SFXBuffer

メンバ

コンストラクタ/デストラクタ
SFXConfig( `Void` ) SFXConfig クラスのコンストラクタです。
~SFXConfig( `Void` ) SFXConfig クラスのデストラクタです。

パブリック関数
`Void`	Clear( `Void` ) すべてのエントリを削除します。
static `SFXConfigConstRef`	EmptyInstance( `Void` ) 空のコンフィグを取得します。
`SInt32`	GetSize( `Void` ) このオブジェクト内のエントリ数を取得します。
`SFCError`	Load( `SFXPathConstRef` path ) 指定された設定ファイルから SFXConfig インスタンスをロードします。
`SFCError`	ReadBinary( `UInt16` tag , `VoidConstHandle` value , `UInt16Ptr` length ) 指定されたタグ番号のエントリからバイナリデータを読み込みます。
`Bool`	ReadBool( `UInt16` tag , `Bool` initial ) 指定されたタグ番号のエントリから Bool 型の値を読み込みます
`Float32`	ReadFloat32( `UInt16` tag , `Float32` initial ) 指定されたタグ番号のエントリから Float32 型の値を読み込みます
`Float64`	ReadFloat64( `UInt16` tag , `Float64` initial ) 指定されたタグ番号のエントリから Float64 型の値を読み込みます
`SFXAnsiString`	ReadSFXAnsiString( `UInt16` tag , `SFXAnsiStringConstRef` initial ) 指定されたタグ番号のエントリから SFXAnsiString 型の値（文字列）を読み込みます。
`SFXBuffer`	ReadSFXBuffer( `UInt16` tag , `SFXBufferConstRef` initial ) 指定されたタグ番号のエントリから SFXBuffer 型の値を読み込みます。
`SFXWideString`	ReadSFXWideString( `UInt16` tag , `SFXWideStringConstRef` initial ) 指定されたタグ番号のエントリから SFXWideString 型の値（文字列）を読み込みます。
`SInt08`	ReadSInt08( `UInt16` tag , `SInt08` initial ) 指定されたタグ番号のエントリから SInt08 型の値を読み込みます
`SInt16`	ReadSInt16( `UInt16` tag , `SInt16` initial ) 指定されたタグ番号のエントリから SInt16 型の値を読み込みます
`SInt32`	ReadSInt32( `UInt16` tag , `SInt32` initial ) 指定されたタグ番号のエントリから SInt32 型の値を読み込みます
`SInt64`	ReadSInt64( `UInt16` tag , `SInt64` initial ) 指定されたタグ番号のエントリから SInt64 型の値を読み込みます
`UInt08`	ReadUInt08( `UInt16` tag , `UInt08` initial ) 指定されたタグ番号のエントリから UInt08 型の値を読み込みます
`UInt16`	ReadUInt16( `UInt16` tag , `UInt16` initial ) 指定されたタグ番号のエントリから UInt16 型の値を読み込みます
`UInt32`	ReadUInt32( `UInt16` tag , `UInt32` initial ) 指定されたタグ番号のエントリから UInt32 型の値を読み込みます
`UInt64`	ReadUInt64( `UInt16` tag , `UInt64` initial ) 指定されたタグ番号のエントリから UInt64 型の値を読み込みます
`Void`	Remove( `UInt16` tag ) 指定されたタブを持つエントリを削除します。
`SFCError`	Save( `SFXPathConstRef` path ) このオブジェクトの内容を設定ファイルに保存します。
`SFCError`	Save( `Void` ) このオブジェクトの内容を設定ファイルに保存します。
`SFCError`	WriteBinary( `UInt16` tag , `VoidConstPtr` value , `UInt16` length ) 指定されたタグ番号のエントリにバイナリデータを書き込みます。
`SFCError`	WriteBool( `UInt16` tag , `Bool` value ) 指定されたタグ番号のエントリに Bool 型の値を書き込みます。
`SFCError`	WriteFloat32( `UInt16` tag , `Float32` value ) 指定されたタグ番号のエントリに Float32 型の値を書き込みます。
`SFCError`	WriteFloat64( `UInt16` tag , `Float64` value ) 指定されたタグ番号のエントリに Float64 型の値を書き込みます。
`SFCError`	WriteSFXAnsiString( `UInt16` tag , `SFXAnsiStringConstRef` value ) 指定されたタグ番号のエントリに SFXAnsiString 型の値（文字列）を書き込みます。
`SFCError`	WriteSFXBuffer( `UInt16` tag , `SFXBufferConstRef` value ) 指定されたタグ番号のエントリに SFXBuffer 型の値を書き込みます。
`SFCError`	WriteSFXWideString( `UInt16` tag , `SFXWideStringConstRef` value ) 指定されたタグ番号のエントリに SFXWideString 型の値（文字列）を書き込みます。
`SFCError`	WriteSInt08( `UInt16` tag , `SInt08` value ) 指定されたタグ番号のエントリに SInt08 型の値を書き込みます。
`SFCError`	WriteSInt16( `UInt16` tag , `SInt16` value ) 指定されたタグ番号のエントリに SInt16 型の値を書き込みます。
`SFCError`	WriteSInt32( `UInt16` tag , `SInt32` value ) 指定されたタグ番号のエントリに SInt32 型の値を書き込みます。
`SFCError`	WriteSInt64( `UInt16` tag , `SInt64` value ) 指定されたタグ番号のエントリに SInt64 型の値を書き込みます。
`SFCError`	WriteUInt08( `UInt16` tag , `UInt08` value ) 指定されたタグ番号のエントリに UInt08 型の値を書き込みます。
`SFCError`	WriteUInt16( `UInt16` tag , `UInt16` value ) 指定されたタグ番号のエントリに UInt16 型の値を書き込みます。
`SFCError`	WriteUInt32( `UInt16` tag , `UInt32` value ) 指定されたタグ番号のエントリに UInt32 型の値を書き込みます。
`SFCError`	WriteUInt64( `UInt16` tag , `UInt64` value ) 指定されたタグ番号のエントリに UInt64 型の値を書き込みます。

SFXConfig::SFXConfig

SFXConfig クラスのコンストラクタです。

[ public, explicit ]
SFXConfig(Void);

解説

このコンストラクタでは、何も行いません。

SFXConfig::~SFXConfig

SFXConfig クラスのデストラクタです。

[ public ]
~SFXConfig(Void);

解説

このデストラクタは、 SFXConfig::Clear 関数を呼び出し、このオブジェクト中のエントリをすべて削除します。

参照

SFXConfig::Clear

SFXConfig::Clear

すべてのエントリを削除します。

[ public ]
Void Clear(Void);

解説

この関数は、このオブジェクト内のすべてのエントリを削除します。

	注意
	この関数は、`SFXConfig::~SFXConfig` デストラクタから呼び出されます。

	注意
	この関数を呼び出して更新したこのオブジェクトの内容は、 `SFXConfig::Save` 関数を呼び出さない限り設定ファイルに反映されません。

使用例

SFXConfig  config;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// Bool 型の値を書き込む
config.WriteBool(100, true);
config.WriteBool(101, false);

// すべてのエントリを削除する
config.Clear();

参照

SFXConfig::Remove | SFXConfig::EmptyInstance | SFXConfig::Save | SFXConfig::~SFXConfig

SFXConfig::EmptyInstance

空のコンフィグを取得します。

[ public, static ]
SFXConfigConstRef EmptyInstance(Void);

戻り値

空のコンフィグを表すインスタンス

解説

この関数は、空のコンフィグを表すインスタンスを取得します。

参照

SFXConfig::Clear

SFXConfig::GetSize

このオブジェクト内のエントリ数を取得します。

[ public, const ]
SInt32 GetSize(Void);

戻り値

このオブジェクト内のエントリ数

解説

この関数は、このオブジェクト内のエントリ数を取得します。

使用例

SFXConfig   config;
UInt32      entryNum = 0;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Bool 型の値を書き込む
config.WriteBool(100, true);
config.WriteBool(101, false);

// エントリ数を取得する
entryNum = config.GetSize();

SFXConfig::Load

指定された設定ファイルから SFXConfig インスタンスをロードします。

[ public ]
SFCError Load(
    SFXPathConstRef path   // 設定ファイルのパス
);

戻り値

成功したとき、または設定ファイルが存在しないとき: SFERR_NO_ERROR
path 引数がディレクトリであるとき: SFERR_INVALID_PARAM
ファイルが既に開いているとき: SFERR_INVALID_STATE
メモリ不足のとき: SFERR_NO_MEMORY
その他: BREW API IFILEMGR_GetLastError 関数が返すエラー、またはSFERR_FAILED

解説

この関数は、指定された設定ファイルから SFXConfig::Save 関数を使用して保存した SFXConfig インスタンスをロードします。

path 引数に指定した設定ファイルのパスはこの SFXConfig インスタンスに保持されます。そして、引数を省略して SFXConfig::Save 関数を呼び出すと、このパスの設定ファイルに SFXConfig インスタンスが保存されます。

	Tip
	`SFXConfig` クラスを利用する場合、この関数を最初に呼び出します。

	注意
	設定ファイルを複数回ロードした場合は、最後にロードした設定ファイルの内容が有効となり、それ以外の設定ファイルの内容は破棄されます。

使用例

SFXConfig   config;
Bool        bool_0(true), bool_1(false);
Bool        bool_a, bool_b;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Bool 型の値を書き込む
config.WriteBool(100, bool_0);
config.WriteBool(101, bool_1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Bool 型の値を読み込む
bool_a = config.ReadBool(100, bool_0);
bool_b = config.ReadBool(101, bool_1);

参照

SFXConfig::Save | SFXConfig | BREW API IFILEMGR_GetLastError

SFXConfig::ReadBinary

指定されたタグ番号のエントリからバイナリデータを読み込みます。

[ public, const ]
SFCError ReadBinary(
    UInt16 tag              // タグ
    VoidConstHandle value   // 値を格納するハンドル
    UInt16Ptr length        // データの長さを格納するポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
指定したタグ番号のエントリが存在しないとき: SFERR_FAILED

解説

この関数は、指定されたタグ番号のエントリからバイナリデータを読み込みます。

SFXConfig::WriteBinary 関数を使用して書き込んだバイナリデータが、 value 引数と length 引数に返ります。

エントリが存在しないときは、 SFERR_FAILED を返します。

使用例

SFXConfig          config;
AChar              moji[] = {"abcdefghijkxyz"};
VoidConstPtr       data;
UInt16             len;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Binary データを書き込む
config.WriteBinary(100, (VoidConstPtr)moji, SFXHelper::strlen(moji) + 1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Binary データを取得する
config.ReadBinary(100, &data, &len);

参照

SFXConfig::WriteBinary

SFXConfig::ReadBool

指定されたタグ番号のエントリから Bool 型の値を読み込みます

[ public, const ]
Bool ReadBool(
    UInt16 tag     // タグ
    Bool initial   // デフォルト値
);

戻り値

SFXConfig::WriteBool 関数を使用して書き込んだ Bool 型の値

解説

この関数は、指定されたタグ番号のエントリから Bool 型の値を読み込みます。

SFXConfig::WriteBool 関数を使用して書き込んだ Bool 型の値が返ります。

ただし、エントリの値のサイズが Bool 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

使用例

SFXConfig   config;
Bool        bool_0(true), bool_1(false);
Bool        bool_a, bool_b;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Bool 型の値を書き込む
config.WriteBool(100, bool_0);
config.WriteBool(101, bool_1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Bool 型の値を読み込む
bool_a = config.ReadBool(100, bool_0);
bool_b = config.ReadBool(101, bool_1);

参照

SFXConfig::WriteBool

SFXConfig::ReadFloat32

指定されたタグ番号のエントリから Float32 型の値を読み込みます

[ public, const ]
Float32 ReadFloat32(
    UInt16 tag        // タグ
    Float32 initial   // デフォルト値
);

戻り値

SFXConfig::WriteFloat32 関数を使用して書き込んだ Float32 型の値

解説

この関数は、指定されたタグ番号のエントリから Float32 型の値を読み込みます。

SFXConfig::WriteFloat32 関数を使用して書き込んだ Float32 型の値が返ります。

ただし、エントリの値のサイズが Float32 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteFloat32

SFXConfig::ReadFloat64

指定されたタグ番号のエントリから Float64 型の値を読み込みます

[ public, const ]
Float64 ReadFloat64(
    UInt16 tag        // タグ
    Float64 initial   // デフォルト値
);

戻り値

SFXConfig::WriteFloat64 関数を使用して書き込んだ Float64 型の値

解説

この関数は、指定されたタグ番号のエントリから Float64 型の値を読み込みます。

SFXConfig::WriteFloat64 関数を使用して書き込んだ Float64 型の値が返ります。

ただし、エントリの値のサイズが Float64 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

使用例

SFXConfig   config;
Float64     float64_1(0.12345), float64_2(0.000000), float64_3(-1.234);
Float64     float64_a, float64_b, float64_c;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Float64 型の値を書き込む
config.WriteFloat64(100, float64_1);
config.WriteFloat64(101, float64_2);
config.WriteFloat64(102, float64_3);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Float64 型の値を読み込む
float64_a = config.ReadFloat64(100, float64_0);
float64_b = config.ReadFloat64(101, float64_1);
float64_c = config.ReadFloat64(102, float64_2);

参照

SFXConfig::WriteFloat64

SFXConfig::ReadSFXAnsiString

指定されたタグ番号のエントリから SFXAnsiString 型の値（文字列）を読み込みます。

[ public, const ]
SFXAnsiString ReadSFXAnsiString(
    UInt16 tag                      // タグ
    SFXAnsiStringConstRef initial   // デフォルト値
);

戻り値

SFXConfig::WriteSFXAnsiString 関数を使用して書き込んだ SFXAnsiString 型の値（文字列）

解説

この関数は、指定されたタグ番号のエントリから SFXAnsiString 型の値（文字列）を読み込みます。

SFXConfig::WriteSFXAnsiString 関数を使用して書き込んだ SFXAnsiString 型の値（文字列）が返ります。

ただし、エントリの値のサイズが 0 であるとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

	注意
	`SFXAnsiString` 型の値（文字列）は、ヌル文字を含む形で管理しています。値の長さが 1 バイトの場合は、空文字列 (ヌル文字列) を含む `SFXAnsiString` インスタンスを返します。

使用例

SFXConfig      config;
SFXAnsiString  string;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SFXAnsiString 型の値を書き込む
config.WriteSFXAnsiString(100, "Config");
config.WriteSFXAnsiString(101, "Sample");
config.WriteSFXAnsiString(102, "SophiaFramework");

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SFXAnsiString 型の値を読み込む
string = config.ReadSFXAnsiString(100, "Read Config");

参照

SFXConfig::WriteSFXAnsiString | SFXAnsiString

SFXConfig::ReadSFXBuffer

指定されたタグ番号のエントリから SFXBuffer 型の値を読み込みます。

[ public, const ]
SFXBuffer ReadSFXBuffer(
    UInt16 tag                  // タグ
    SFXBufferConstRef initial   // デフォルト値
);

戻り値

SFXConfig::WriteSFXBuffer 関数を使用して書き込んだ SFXBuffer 型の値

解説

この関数は、指定されたタグ番号のエントリから SFXBuffer 型の値を読み込みます。

SFXConfig::WriteSFXBuffer 関数を使用して書き込んだ SFXBuffer 型の値が返ります。

エントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteSFXBuffer | SFXBuffer

SFXConfig::ReadSFXWideString

指定されたタグ番号のエントリから SFXWideString 型の値（文字列）を読み込みます。

[ public, const ]
SFXWideString ReadSFXWideString(
    UInt16 tag                      // タグ
    SFXWideStringConstRef initial   // デフォルト値
);

戻り値

SFXConfig::WriteSFXWideString 関数を使用して書き込んだ SFXWideString 型の値（文字列）

解説

この関数は、指定されたタグ番号のエントリから SFXWideString 型の値（文字列）を読み込みます。

SFXConfig::WriteSFXWideString 関数を使用して書き込んだ SFXWideString 型の値（文字列）が返ります。

ただし、エントリの値のサイズが 0 であるとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

	注意
	`SFXWideString` 型の値（文字列）は、ヌル文字を含む形で管理しています。値の長さが 2 バイトの場合は、空文字列 (ヌル文字列) を含む `SFXWideString` インスタンスを返します。

使用例

SFXConfig      config;
SFXWideString  string;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SFXWideString 型の値を書き込む
config.WriteSFXWideString(100, "Config");
config.WriteSFXWideString(101, "Sample");
config.WriteSFXWideString(102, "SophiaFramework");

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SFXWideString 型の値を読み込む
string = config.ReadSFXWideString(100, "Read Config");

参照

SFXConfig::WriteSFXWideString | SFXWideString

SFXConfig::ReadSInt08

指定されたタグ番号のエントリから SInt08 型の値を読み込みます

[ public, const ]
SInt08 ReadSInt08(
    UInt16 tag       // タグ
    SInt08 initial   // デフォルト値
);

戻り値

SFXConfig::WriteSInt08 関数を使用して書き込んだ SInt08 型の値

解説

この関数は、指定されたタグ番号のエントリから SInt08 型の値を読み込みます。

SFXConfig::WriteSInt08 関数を使用して書き込んだ SInt08 型の値が返ります。

	注意
	エントリの値のサイズが SInt08 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteSInt08

SFXConfig::ReadSInt16

指定されたタグ番号のエントリから SInt16 型の値を読み込みます

[ public, const ]
SInt16 ReadSInt16(
    UInt16 tag       // タグ
    SInt16 initial   // デフォルト値
);

戻り値

SFXConfig::WriteSInt16 関数を使用して書き込んだ SInt16 型の値

解説

この関数は、指定されたタグ番号のエントリから SInt16 型の値を読み込みます。

SFXConfig::WriteSInt16 関数を使用して書き込んだ SInt16 型の値が返ります。

ただし、エントリの値のサイズが SInt16 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteSInt16

SFXConfig::ReadSInt32

指定されたタグ番号のエントリから SInt32 型の値を読み込みます

[ public, const ]
SInt32 ReadSInt32(
    UInt16 tag       // タグ
    SInt32 initial   // デフォルト値
);

戻り値

SFXConfig::WriteSInt32 関数を使用して書き込んだ SInt32 型の値

解説

この関数は、指定されたタグ番号のエントリから SInt32 型の値を読み込みます。

SFXConfig::WriteSInt32 関数を使用して書き込んだ SInt32 型の値が返ります。

ただし、エントリの値のサイズが SInt32 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

使用例

SFXConfig   config;
SInt32      i_0(10), i_1(20), i_2(30);
SInt32      i_a, i_b, i_c;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SInt32 型の値を書き込む
config.WriteSInt32(100, i_0);
config.WriteSInt32(101, i_1);
config.WriteSInt32(102, i_2);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SInt32 型の値を読み込む
i_a = config.ReadSInt32(100, i_0);
i_b = config.ReadSInt32(101, i_1);
i_c = config.ReadSInt32(102, i_2);

参照

SFXConfig::WriteSInt32

SFXConfig::ReadSInt64

指定されたタグ番号のエントリから SInt64 型の値を読み込みます

[ public, const ]
SInt64 ReadSInt64(
    UInt16 tag       // タグ
    SInt64 initial   // デフォルト値
);

戻り値

SFXConfig::WriteSInt64 関数を使用して書き込んだ SInt64 型の値

解説

この関数は、指定されたタグ番号のエントリから SInt64 型の値を読み込みます。

SFXConfig::WriteSInt64 関数を使用して書き込んだ SInt64 型の値が返ります。

ただし、エントリの値のサイズが SInt64 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteSInt64

SFXConfig::ReadUInt08

指定されたタグ番号のエントリから UInt08 型の値を読み込みます

[ public, const ]
UInt08 ReadUInt08(
    UInt16 tag       // タグ
    UInt08 initial   // デフォルト値
);

戻り値

SFXConfig::WriteUInt08 関数を使用して書き込んだ UInt08 型の値

解説

この関数は、指定されたタグ番号のエントリから UInt08 型の値を読み込みます。

SFXConfig::WriteUInt08 関数を使用して書き込んだ UInt08 型の値が返ります。

ただし、エントリの値のサイズが UInt08 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteUInt08

SFXConfig::ReadUInt16

指定されたタグ番号のエントリから UInt16 型の値を読み込みます

[ public, const ]
UInt16 ReadUInt16(
    UInt16 tag       // タグ
    UInt16 initial   // デフォルト値
);

戻り値

SFXConfig::WriteUInt16 関数を使用して書き込んだ UInt16 型の値

解説

この関数は、指定されたタグ番号のエントリから UInt16 型の値を読み込みます。

SFXConfig::WriteUInt16 関数を使用して書き込んだ UInt16 型の値が返ります。

ただし、エントリの値のサイズが UInt16 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteUInt16

SFXConfig::ReadUInt32

指定されたタグ番号のエントリから UInt32 型の値を読み込みます

[ public, const ]
UInt32 ReadUInt32(
    UInt16 tag       // タグ
    UInt32 initial   // デフォルト値
);

戻り値

SFXConfig::WriteUInt32 関数を使用して書き込んだ UInt32 型の値

解説

この関数は、指定されたタグ番号のエントリから UInt32 型の値を読み込みます。

SFXConfig::WriteUInt32 関数を使用して書き込んだ UInt32 型の値が返ります。

ただし、エントリの値のサイズが UInt32 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteUInt32

SFXConfig::ReadUInt64

指定されたタグ番号のエントリから UInt64 型の値を読み込みます

[ public, const ]
UInt64 ReadUInt64(
    UInt16 tag       // タグ
    UInt64 initial   // デフォルト値
);

戻り値

SFXConfig::WriteUInt64 関数を使用して書き込んだ UInt64 型の値

解説

この関数は、指定されたタグ番号のエントリから UInt64 型の値を読み込みます。

SFXConfig::WriteUInt64 関数を使用して書き込んだ UInt64 型の値が返ります。

ただし、エントリの値のサイズが UInt64 型のサイズと等しくないとき、またはエントリが存在しないときは、 initial 引数に指定した値を返します。

参照

SFXConfig::WriteUInt64

SFXConfig::Remove

指定されたタブを持つエントリを削除します。

[ public ]
Void Remove(
    UInt16 tag   // タグ
);

解説

この関数は、指定されたタブを持つエントリを削除します。

指定したタグ番号のエントリがこのオブジェクト中に存在する場合、そのエントリを削除します。

	注意
	この関数を呼び出して更新したこのオブジェクトの内容は、 `SFXConfig::Save` 関数を呼び出さない限り設定ファイルに反映されません。

使用例

SFXConfig     config;

// 設定ファイルをロードする
config.Load(SFXPath("config.cfg"));

// Bool 型の値を書き込みます
config.WriteBool(100, true);
config.WriteBool(101, false);

// 指定したエントリを削除する
config.Remove(101);

参照

SFXConfig::Save

SFXConfig::Save

このオブジェクトの内容を設定ファイルに保存します。

[ public ]
SFCError Save(
    SFXPathConstRef path   // 設定ファイルのパス
);

[ public ]
SFCError Save(Void);

戻り値

成功したとき: SFERR_NO_ERROR
path 引数がディレクトリであるとき: SFERR_INVALID_PARAM
ファイルが既に開いているとき: SFERR_INVALID_STATE
メモリ不足のとき: SFERR_NO_MEMORY
その他: BREW API IFILEMGR_GetLastError 関数が返すエラー、またはSFERR_FAILED

解説

この関数は、このオブジェクトの内容を設定ファイルに保存します。

path 引数に設定ファイル名（パス）を指定しない場合は、 SFXConfig::Load 関数で読み込んだ設定ファイルに保存します。

使用例

SFXConfig   config;
Bool        bool_0(true), bool_1(false);
Bool        bool_a, bool_b;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Bool 型の値を書き込む
config.WriteBool(100, bool_0);
config.WriteBool(101, bool_1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Bool 型の値を読み込む
bool_a = config.ReadBool(100, bool_0);
bool_b = config.ReadBool(101, bool_1);

参照

SFXConfig::Load | BREW API IFILEMGR_GetLastError

SFXConfig::WriteBinary

指定されたタグ番号のエントリにバイナリデータを書き込みます。

[ public ]
SFCError WriteBinary(
    UInt16 tag           // タグ
    VoidConstPtr value   // バイナリデータを指すポインタ
    UInt16 length        // バイナリデータの長さ
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
value 引数が null であるとき、またはlength 引数が 0 であるとき: SFERR_INVALID_PARAM

解説

この関数は、指定されたタグ番号のエントリにバイナリデータを書き込みます。

具体的には、（tag 引数で指定したタグ, value 引数と length 引数で指定した値）のペアをエントリとしてこのオブジェクトに書き込みます。同じタグ番号のエントリが既に存在する場合は、そのエントリは上書きされます。

書き込んだバイナリデータは、 SFXConfig::ReadBinary 関数を使用して読み込めます。

使用例

SFXConfig          config;
AChar              moji[] = {"abcdefghijkxyz"};
VoidConstPtr       data;
UInt16             len;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Binary データを書き込む
config.WriteBinary(100, (VoidConstPtr)moji, SFXHelper::strlen(moji) + 1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Binary データを取得する
config.ReadBinary(100, &data, &len);

参照

SFXConfig::ReadBinary

SFXConfig::WriteBool

指定されたタグ番号のエントリに Bool 型の値を書き込みます。

[ public ]
SFCError WriteBool(
    UInt16 tag   // タグ
    Bool value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに Bool 型の値を書き込みます。

具体的には、（tag 引数で指定したタグ, value 引数で指定した値）のペアをエントリとしてこのオブジェクトに書き込みます。同じタグ番号のエントリが既に存在する場合は、そのエントリは上書きされます。

書き込んだ Bool 型の値は、 SFXConfig::ReadBool 関数を使用して読み込めます。

使用例

SFXConfig   config;
Bool        bool_0(true), bool_1(false);
Bool        bool_a, bool_b;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Bool 型の値を書き込む
config.WriteBool(100, bool_0);
config.WriteBool(101, bool_1);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Bool 型の値を読み込む
bool_a = config.ReadBool(100, bool_0);
bool_b = config.ReadBool(101, bool_1);

参照

SFXConfig::ReadBool

SFXConfig::WriteFloat32

指定されたタグ番号のエントリに Float32 型の値を書き込みます。

[ public ]
SFCError WriteFloat32(
    UInt16 tag      // タグ
    Float32 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに Float32 型の値を書き込みます。

書き込んだ Float32 型の値は、 SFXConfig::ReadFloat32 関数を使用して読み込めます。

参照

SFXConfig::ReadFloat32

SFXConfig::WriteFloat64

指定されたタグ番号のエントリに Float64 型の値を書き込みます。

[ public ]
SFCError WriteFloat64(
    UInt16 tag      // タグ
    Float64 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに Float64 型の値を書き込みます。

書き込んだ Float64 型の値は、 SFXConfig::ReadFloat64 関数を使用して読み込めます。

使用例

SFXConfig   config;
Float64     float64_1(0.12345), float64_2(0.000000), float64_3(-1.234);
Float64     float64_a, float64_b, float64_c;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに Float64 型の値を書き込む
config.WriteFloat64(100, float64_1);
config.WriteFloat64(101, float64_2);
config.WriteFloat64(102, float64_3);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから Float64 型の値を読み込む
float64_a = config.ReadFloat64(100, float64_0);
float64_b = config.ReadFloat64(101, float64_1);
float64_c = config.ReadFloat64(102, float64_2);

参照

SFXConfig::ReadFloat64

SFXConfig::WriteSFXAnsiString

指定されたタグ番号のエントリに SFXAnsiString 型の値（文字列）を書き込みます。

[ public ]
SFCError WriteSFXAnsiString(
    UInt16 tag                    // タグ
    SFXAnsiStringConstRef value   // 文字列
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
文字列のサイズが UINT16_MAXIMUM より大きいとき: SFERR_INVALID_PARAM

解説

この関数は、指定されたタグ番号のエントリに SFXAnsiString 型の値（文字列）を書き込みます。

文字列が空文字列 (ヌル文字列) の場合は、ヌル文字をエントリの値に書き込みます。

書き込んだ SFXAnsiString 型の値（文字列）は、 SFXConfig::ReadSFXAnsiString 関数を使用して読み込めます。

使用例

SFXConfig      config;
SFXAnsiString  string;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SFXAnsiString 型の値を書き込む
config.WriteSFXAnsiString(100, "Config");
config.WriteSFXAnsiString(101, "Sample");
config.WriteSFXAnsiString(102, "SophiaFramework");

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SFXAnsiString 型の値を読み込む
string = config.ReadSFXAnsiString(100, "Read Config");

参照

SFXConfig::ReadSFXAnsiString | SFXAnsiString

SFXConfig::WriteSFXBuffer

指定されたタグ番号のエントリに SFXBuffer 型の値を書き込みます。

[ public ]
SFCError WriteSFXBuffer(
    UInt16 tag                // タグ
    SFXBufferConstRef value   // SFXBuffer 型のデータ
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
SFXBuffer 型のデータサイズが UINT16_MAXIMUM より大きいとき: SFERR_INVALID_PARAM

解説

この関数は、指定されたタグ番号のエントリに SFXBuffer 型の値を書き込みます。

書き込んだ SFXBuffer 型の値は、 SFXConfig::ReadSFXBuffer 関数を使用して読み込めます。

参照

SFXConfig::ReadSFXBuffer | SFXBuffer

SFXConfig::WriteSFXWideString

指定されたタグ番号のエントリに SFXWideString 型の値（文字列）を書き込みます。

[ public ]
SFCError WriteSFXWideString(
    UInt16 tag                    // タグ
    SFXWideStringConstRef value   // 文字列
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
文字列のサイズが UINT16_MAXIMUM より大きいとき: SFERR_INVALID_PARAM

解説

この関数は、指定されたタグ番号のエントリに SFXWideString 型の値（文字列）を書き込みます。

文字列が空文字列 (ヌル文字列) の場合は、ヌル文字をエントリの値に書き込みます。

書き込んだ SFXWideString 型の値（文字列）は、 SFXConfig::ReadSFXWideString 関数を使用して読み込めます。

使用例

SFXConfig      config;
SFXWideString  string;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SFXWideString 型の値を書き込む
config.WriteSFXWideString(100, "Config");
config.WriteSFXWideString(101, "Sample");
config.WriteSFXWideString(102, "SophiaFramework");

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SFXWideString 型の値を読み込む
string = config.ReadSFXWideString(100, "Read Config");

参照

SFXConfig::ReadSFXWideString | SFXWideString

SFXConfig::WriteSInt08

指定されたタグ番号のエントリに SInt08 型の値を書き込みます。

[ public ]
SFCError WriteSInt08(
    UInt16 tag     // タグ
    SInt08 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに SInt08 型の値を書き込みます。

書き込んだ SInt08 型の値は、 SFXConfig::ReadSInt08 関数を使用して読み込めます。

参照

SFXConfig::ReadSInt08

SFXConfig::WriteSInt16

指定されたタグ番号のエントリに SInt16 型の値を書き込みます。

[ public ]
SFCError WriteSInt16(
    UInt16 tag     // タグ
    SInt16 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに SInt16 型の値を書き込みます。

書き込んだ SInt16 型の値は、 SFXConfig::ReadSInt16 関数を使用して読み込めます。

参照

SFXConfig::ReadSInt16

SFXConfig::WriteSInt32

指定されたタグ番号のエントリに SInt32 型の値を書き込みます。

[ public ]
SFCError WriteSInt32(
    UInt16 tag     // タグ
    SInt32 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに SInt32 型の値を書き込みます。

書き込んだ SInt32 型の値は、 SFXConfig::ReadSInt32 関数を使用して読み込めます。

使用例

SFXConfig   config;
SInt32      i_0(10), i_1(20), i_2(30);
SInt32      i_a, i_b, i_c;

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリに SInt32 型の値を書き込む
config.WriteSInt32(100, i_0);
config.WriteSInt32(101, i_1);
config.WriteSInt32(102, i_2);

// SFXConfig インスタンスを設定ファイルに保存する
config.Save();

// 設定ファイルから SFXConfig インスタンスをロードする
config.Load(SFXPath("config.cfg"));

// SFXConfig インスタンス内の指定したタグ番号のエントリから SInt32 型の値を読み込む
i_a = config.ReadSInt32(100, i_0);
i_b = config.ReadSInt32(101, i_1);
i_c = config.ReadSInt32(102, i_2);

参照

SFXConfig::ReadSInt32

SFXConfig::WriteSInt64

指定されたタグ番号のエントリに SInt64 型の値を書き込みます。

[ public ]
SFCError WriteSInt64(
    UInt16 tag     // タグ
    SInt64 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに SInt64 型の値を書き込みます。

書き込んだ SInt64 型の値は、 SFXConfig::ReadSInt64 関数を使用して読み込めます。

参照

SFXConfig::ReadSInt64

SFXConfig::WriteUInt08

指定されたタグ番号のエントリに UInt08 型の値を書き込みます。

[ public ]
SFCError WriteUInt08(
    UInt16 tag     // タグ
    UInt08 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに UInt08 型の値を書き込みます。

書き込んだ UInt08 型の値は、 SFXConfig::ReadUInt08 関数を使用して読み込めます。

参照

SFXConfig::ReadUInt08

SFXConfig::WriteUInt16

指定されたタグ番号のエントリに UInt16 型の値を書き込みます。

[ public ]
SFCError WriteUInt16(
    UInt16 tag     // タグ
    UInt16 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに UInt16 型の値を書き込みます。

書き込んだ UInt16 型の値は、 SFXConfig::ReadUInt16 関数を使用して読み込めます。

参照

SFXConfig::ReadUInt16

SFXConfig::WriteUInt32

指定されたタグ番号のエントリに UInt32 型の値を書き込みます。

[ public ]
SFCError WriteUInt32(
    UInt16 tag     // タグ
    UInt32 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに UInt32 型の値を書き込みます。

書き込んだ UInt32 型の値は、 SFXConfig::ReadUInt32 関数を使用して読み込めます。

参照

SFXConfig::ReadUInt32

SFXConfig::WriteUInt64

指定されたタグ番号のエントリに UInt64 型の値を書き込みます。

[ public ]
SFCError WriteUInt64(
    UInt16 tag     // タグ
    UInt64 value   // 値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、指定されたタグ番号のエントリに UInt64 型の値を書き込みます。

書き込んだ UInt64 型の値は、 SFXConfig::ReadUInt64 関数を使用して読み込めます。

参照

SFXConfig::ReadUInt64