iniファイルアクセスクラス [詳解]

#include <TnbInifileAccessor.h>

CInifileAccessor の継承関係図

公開型
typedef CMapT< CStr, CValue, LPCTSTR >	CKeyMap
	キーと値のマップ型宣言 [詳解]

typedef CTreeT< CStr, CValue, LPCTSTR >	CKeyTree
	キーと値のツリー型宣言 [詳解]

enum	EKind { EK_Nothing = 'n' , EK_String = 's' , EK_PluralStrings = 'p' , EK_Binary = 'b' , EK_Dword = 'd' , EK_Longlong = 'i' }
	値型の種類. [詳解]

公開メンバ関数
	CInifileAccessor (LPCTSTR lpszFile=NULL)
	コンストラクタ [詳解]

bool	DeleteAllSection (void)
	[削除] 全セクション削除 [詳解]

virtual bool	DeleteSection (LPCTSTR lpszSectionName)
	[削除] 指定セクション削除 [詳解]

virtual CStrVector	EnumKeyNames (LPCTSTR lpszSectionName) const
	[取得] 名前一覧取得 [詳解]

virtual CStrVector	EnumSectionNames (LPCTSTR lpszSectionName=NULL) const
	[取得] セクション名一覧取得 [詳解]

bool	ExistBaseFile (void) const
	[確認] 対象ファイル存在確認. [詳解]

virtual bool	Flush (void)
	[操作] フラッシュ. [詳解]

CStr	GetBaseFileName (void) const
	[取得] 対象ファイル取得 [詳解]

virtual EKind	GetKeyKind (LPCTSTR lpszSectionName, LPCTSTR lpszKey) const
	[取得] 情報取種取得 [詳解]

void	GetKeyTree (CKeyTree &_tree) const
	[取得] 全値取得 [詳解]

void	GetKeyTree (CStrsTree &_tree) const
	[取得] 全値取得 [詳解]

virtual CStr	GetTypeName (void) const
	[取得] タイプ名取得 [詳解]

bool	NewBaseFile (bool isUnicode=false)
	[作成] 対象ファイル作成. [詳解]

CSection	operator[] (LPCTSTR lpszSectionName)
	[取得] CSection取得 [詳解]

const CSection	operator[] (LPCTSTR lpszSectionName) const
	[取得] CSection取得 [詳解]

virtual CValue	QueryValue (LPCTSTR lpszSectionName, LPCTSTR lpszKey) const
	[取得] 情報取得 [詳解]

void	SetBase (LPCTSTR lpszFile=NULL)
	[設定] 対象ファイル指定 [詳解]

virtual bool	WriteValue (LPCTSTR lpszSectionName, LPCTSTR lpszKey, const IAccessor::CValue &value)
	[設定] 情報設定 [詳解]

静的公開メンバ関数
static CStr	MakeDefineFilePath (void)
	[作成] 定義ファイル名作成. [詳解]

static CStr	MakeInifilePath (void)
	[作成] iniファイルパス作成. [詳解]

template<typename TYP >
static CVectorT< IAccessor::CValue >	ToValueVector (const CVectorT< TYP > &vt)
	[変換] 配列変換. [詳解]

詳解

iniファイルアクセスクラス

iniファイルにアクセスする関数群です。
APIの GetPrivateProfile〜 関数 SetPrivateProfile〜 とファイル互換が有ります。

ただし、すべてにおいて、文字列として処理しています。

コンストラクタや SetBase() で情報のベースを指定し、
operator[]() で セクション情報アクセスクラス({@link IAccessor::CSection CSection})を取得し、
Query〜() 、 Write〜() などでキー情報にアクセスします。

覚え書き: 本インターフェースにも QueryValue() , WriteValue() など、セクションを指定しキー情報を操作するメソッドもありますが、基本的に CSection を使用してください。

参照: IAccessor を実装しています。

必要ファイル: TnbInifileAccessor.h

日付: 06/01/01 新規作成; 06/04/20 CString未使用に; 06/05/08 CDoubleNullTerminateStrを使用するようにした。; 06/05/16 IAccessor を実装するようにした。; 06/06/08 メンバ名変更。; 06/10/31 IInformation の改修に対応。; 07/05/10 クラス名変更。; 08/04/03 デフォルト値の扱いを修正。; 09/07/28 NewBaseFile() 追加。; 11/09/15 書き込む際、先に読み出し、同じなら何もしないようにした。; 11/11/07 上記対応にバグあり。一文字の時に、正しく書き込めない可能性があった。

TnbInifileAccessor.h の 57 行目に定義があります。

型定義メンバ詳解

◆ CKeyMap

typedef CMapT<CStr, CValue, LPCTSTR> CKeyMap

inherited

キーと値のマップ型宣言

TnbAccessor.h の 266 行目に定義があります。

◆ CKeyTree

typedef CTreeT<CStr, CValue, LPCTSTR> CKeyTree

inherited

キーと値のツリー型宣言

TnbAccessor.h の 269 行目に定義があります。

列挙型メンバ詳解

◆ EKind

enum EKind

inherited

値型の種類.

IAccessor と IAccessor::CValue で使う型の種類です。

列挙値
EK_Nothing	存在しない
EK_String	文字列
EK_PluralStrings	複数の文字列群
EK_Binary	バイナリ
EK_Dword	32Bit Unsigned Integer
EK_Longlong	64Bit Signed Integer

TnbAccessor.h の 79 行目に定義があります。

構築子と解体子

◆ CInifileAccessor()

CInifileAccessor ( LPCTSTR lpszFile = NULL )

explicit

コンストラクタ

引数

lpszFile ファイル名。省略すると、 MakeInifilePath() の結果が使われます。

TnbInifileAccessor.h の 66 行目に定義があります。

関数詳解

◆ DeleteAllSection()

bool DeleteAllSection ( void )

inherited

[削除] 全セクション削除

戻り値

true	成功
false	失敗

TnbAccessor.h の 1006 行目に定義があります。

◆ DeleteSection()

virtual bool DeleteSection ( LPCTSTR lpszSectionName )

virtual

[削除] 指定セクション削除

引数

lpszSectionName セクション名。

戻り値

true	成功
false	失敗

IAccessorを実装しています。

TnbInifileAccessor.h の 241 行目に定義があります。

◆ EnumKeyNames()

virtual CStrVector EnumKeyNames ( LPCTSTR lpszSectionName ) const

virtual

[取得] 名前一覧取得

引数

lpszSectionName セクション名

戻り値: 名前一覧。無効状態なら未対応。

IAccessorを実装しています。

CExInifileAccessorで再実装されています。

TnbInifileAccessor.h の 275 行目に定義があります。

◆ EnumSectionNames()

virtual CStrVector EnumSectionNames ( LPCTSTR lpszSectionName = NULL ) const

virtual

[取得] セクション名一覧取得

引数

lpszSectionName セクション名。 NULLを指定すると、ROOTのセクション一覧が得られます。

戻り値: セクション名一覧

IAccessorを実装しています。

TnbInifileAccessor.h の 179 行目に定義があります。

◆ ExistBaseFile()

bool ExistBaseFile ( void ) const

[確認] 対象ファイル存在確認.

対象の ini ファイルが、現在存在しているか、確認できます。

覚え書き: ファイルの有無のみ、チェックしています。

戻り値

true	あり。
false	無し。

TnbInifileAccessor.h の 108 行目に定義があります。

◆ Flush()

virtual bool Flush ( void )

virtual

[操作] フラッシュ.

覚え書き: メモリ上にキャッシュがあれば書き出します。

戻り値: true （成功）

CAbstractAccessorを再実装しています。

TnbInifileAccessor.h の 168 行目に定義があります。

◆ GetBaseFileName()

CStr GetBaseFileName ( void ) const

[取得] 対象ファイル取得

戻り値: ファイル名

TnbInifileAccessor.h の 96 行目に定義があります。

◆ GetKeyKind()

virtual EKind GetKeyKind	(	LPCTSTR	lpszSectionName,
		LPCTSTR	lpszKey
	)		const

virtual

[取得] 情報取種取得

覚え書き: 本クラスでは EK_String か EK_Nothing になります。

引数

lpszSectionName	セクション名
lpszKey	キー名

戻り値: 情報種。ない場合、EK_Nothing になります。

IAccessorを実装しています。

CExInifileAccessorで再実装されています。

TnbInifileAccessor.h の 303 行目に定義があります。

◆ GetKeyTree() [1/2]

void GetKeyTree ( CKeyTree & _tree ) const

inherited

[取得] 全値取得

覚え書き: 全キーと値、さらにサブセクション以下もTreeに格納します。

引数

[out] _tree ツリー

TnbAccessor.h の 1024 行目に定義があります。

◆ GetKeyTree() [2/2]

void GetKeyTree ( CStrsTree & _tree ) const

inherited

[取得] 全値取得

覚え書き: 全キーと値、さらにサブセクション以下もTreeに格納します。値はすべて文字列情報に変換します。

引数

[out] _tree ツリー

TnbAccessor.h の 1040 行目に定義があります。

◆ GetTypeName()

virtual CStr GetTypeName ( void ) const

virtual

[取得] タイプ名取得

戻り値: タイプ名

IAccessorを実装しています。

TnbInifileAccessor.h の 158 行目に定義があります。

◆ MakeDefineFilePath()

static CStr MakeDefineFilePath ( void )

staticinherited

[作成] 定義ファイル名作成.

実行ファイル名の .exeを省いたフルパスを返します。。

戻り値: フルパス

TnbAccessor.h の 1057 行目に定義があります。

◆ MakeInifilePath()

static CStr MakeInifilePath ( void )

static

[作成] iniファイルパス作成.

実行ファイル名の .exeを .iniに変えたものを作成します。

戻り値: iniファイルのFullPath

TnbInifileAccessor.h の 85 行目に定義があります。

◆ NewBaseFile()

bool NewBaseFile ( bool isUnicode = false )

[作成] 対象ファイル作成.

対象ファイルを新規します。今までの情報はすべてなくなります。

覚え書き: 通常、使う必要はありませんが、全部消したい場合、 UNICODE 形式にしたい場合に使います。
CInifileAccessor ini;

if ( ! ini.ExistBaseFile() )

{

ini.NewBaseFile(true); //unicode のiniファイルにする

}

TNB::CInifileAccessor::CInifileAccessor
CInifileAccessor(LPCTSTR lpszFile=NULL)
コンストラクタ
Definition: TnbInifileAccessor.h:66

引数

isUnicode false なら ASCII(S-JIS)、 true なら UNICODE で対象ファイルを新規作成します。

戻り値

true	成功.
false	失敗

TnbInifileAccessor.h の 129 行目に定義があります。

◆ operator[]() [1/2]

CSection operator[] ( LPCTSTR lpszSectionName )

inherited

[取得] CSection取得

引数

lpszSectionName セクション名

戻り値: 指定のセクションをアクセスする CSection

TnbAccessor.h の 976 行目に定義があります。

◆ operator[]() [2/2]

const CSection operator[] ( LPCTSTR lpszSectionName ) const

inherited

[取得] CSection取得

引数

lpszSectionName セクション名

戻り値: 指定のセクションをアクセスする CSection

TnbAccessor.h の 986 行目に定義があります。

◆ QueryValue()

virtual CValue QueryValue	(	LPCTSTR	lpszSectionName,
		LPCTSTR	lpszKey
	)		const

virtual

[取得] 情報取得

引数

lpszSectionName	セクション名
lpszKey	キー名

戻り値: キーの値

IAccessorを実装しています。

CExInifileAccessorで再実装されています。

TnbInifileAccessor.h の 319 行目に定義があります。

◆ SetBase()

void SetBase ( LPCTSTR lpszFile = NULL )

[設定] 対象ファイル指定

引数

lpszFile ファイル名

TnbInifileAccessor.h の 75 行目に定義があります。

◆ ToValueVector()

static CVectorT< IAccessor::CValue > ToValueVector ( const CVectorT< TYP > & vt )

staticinherited

[変換] 配列変換.

IAccessor::CValue の配列に変換します。

引数

vt 配列

戻り値: IAccessor::CValue の配列

TnbAccessor.h の 940 行目に定義があります。

◆ WriteValue()

virtual bool WriteValue	(	LPCTSTR	lpszSectionName,
		LPCTSTR	lpszKey,
		const IAccessor::CValue &	value
	)

virtual

[設定] 情報設定

引数

lpszSectionName	セクション名
lpszKey	キー名
value	設定する値。EK_Nothing の場合、キーを削除します。

戻り値

true	成功
false	失敗

例外

CTnbException 設定失敗時、スローされる可能性があります。

IAccessorを実装しています。

CExInifileAccessorで再実装されています。

TnbInifileAccessor.h の 338 行目に定義があります。

公開型

公開メンバ関数

静的公開メンバ関数

詳解

型定義メンバ詳解

◆ CKeyMap

◆ CKeyTree

列挙型メンバ詳解

◆ EKind

構築子と解体子

◆ CInifileAccessor()

関数詳解

◆ DeleteAllSection()

◆ DeleteSection()

◆ EnumKeyNames()

◆ EnumSectionNames()

◆ ExistBaseFile()

◆ Flush()

◆ GetBaseFileName()

◆ GetKeyKind()

◆ GetKeyTree() [1/2]

◆ GetKeyTree() [2/2]

◆ GetTypeName()

◆ MakeDefineFilePath()

◆ MakeInifilePath()

◆ NewBaseFile()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ QueryValue()

◆ SetBase()

◆ ToValueVector()

◆ WriteValue()