セクション情報アクセスクラス [詳解]

#include <TnbAccessor.h>

公開メンバ関数
bool	CanQuery (void) const
	[確認] 参照可能？そのセクションが存在し読み込める、確認できます。 [詳解]

	CSection (const IAccessor *I, LPCTSTR lpszSectionName)
	代入コンストラクタ [詳解]

bool	DeleteAllKeys (void)
	[削除] 全キー削除 [詳解]

bool	DeleteKey (LPCTSTR lpszKey)
	[削除] 指定キー削除 [詳解]

CStrVector	EnumKeyNames (void) const
	[取得] キー名一覧取得 [詳解]

CStrVector	EnumSectionNames (void) const
	[取得] セクション名一覧取得 [詳解]

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

CKeyMap	GetKeyMap (void) const
	[取得] 全値取得 [詳解]

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

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

CStr	GetSectionName (void) const
	[取得] セクション名取得 [詳解]

bool	HasKey (LPCTSTR lpszKey) const
	[確認] 情報存在確認 [詳解]

bool	InSubSection (LPCTSTR lpszSubName)
	[設定] 対象セクション変更. [詳解]

void	PreviousSubSection (void)
	[設定] 対象セクション変更. [詳解]

CByteVector	QueryData (LPCTSTR lpszKey) const
	[取得] バイナリ情報取得 [詳解]

DWORD	QueryDword (LPCTSTR lpszKey, DWORD dwDefault=0) const
	[取得] 数値情報取得 [詳解]

LONGLONG	QueryLonglong (LPCTSTR lpszKey, LONGLONG llDefault=0) const
	[取得] 数値情報取得 [詳解]

CStrVector	QueryPluralStrings (LPCTSTR lpszKey) const
	[取得] 文字列群情報取得 [詳解]

bool	QuerySerializableData (LPCTSTR lpszKey, ISerializable &_d) const
	[取得] シリアライザブルデータ情報取得 [詳解]

CStr	QueryString (LPCTSTR lpszKey, LPCTSTR lpszDefault=NULL) const
	[取得] 文字列情報取得 [詳解]

template<typename TYP >
bool	QueryStruct (LPCTSTR lpszKey, TYP &_t) const
	[取得] バイナリ情報取得 [詳解]

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

CVectorT< CValue >	QueryVector (void) const
	[取得] 配列値取得 [詳解]

bool	QueryWindowText (LPCTSTR lpszKey, HWND hWnd, LPCTSTR lpszDefault=NULL) const
	[取得] ウィンドウテキスト情報取得 [詳解]

const IAccessor *	ReferAccessor (void) const
	[参照] Accessorインターフェース参照 [詳解]

bool	WriteData (LPCTSTR lpszKey, const IConstCollectionT< BYTE > &c)
	[追加] バイナリ情報記録 [詳解]

bool	WriteData (LPCTSTR lpszKey, size_t len, LPCVOID P)
	[追加] バイナリ情報記録 [詳解]

bool	WriteDword (LPCTSTR lpszKey, DWORD dwValue)
	[追加] 数値情報記録 [詳解]

bool	WriteLonglong (LPCTSTR lpszKey, LONGLONG llValue)
	[追加] 数値情報記録 [詳解]

bool	WritePluralStrings (LPCTSTR lpszKey, const CStrVector &vs)
	[追加] 文字列群情報記録 [詳解]

bool	WriteSerializableData (LPCTSTR lpszKey, const ISerializable &s)
	[追加] シリアライザブルデータ情報記録 [詳解]

bool	WriteString (LPCTSTR lpszKey, LPCTSTR lpszValue)
	[追加] 文字列情報記録 [詳解]

template<typename TYP >
bool	WriteStruct (LPCTSTR lpszKey, const TYP &t)
	[追加] バイナリ情報記録 [詳解]

bool	WriteValue (LPCTSTR lpszKey, const CValue &value)
	[追加] 情報記録 [詳解]

bool	WriteVector (const CVectorT< CValue > &vv)
	[追加] 配列値記録 [詳解]

bool	WriteWindowText (LPCTSTR lpszKey, HWND hWnd)
	[追加] ウィンドウテキスト情報記録 [詳解]

詳解

セクション情報アクセスクラス

IAccessor のサブクラスにより作成されるクラスです。
本インスタンスで IAccessor のサブクラスの指定のセクションの情報にアクセスします。

参照: IAccessor

注意: 本クラスは作成元の IAccessor のサブクラスのインスタンスの参照を持っています。必ず本クラスの有効の間は、作成元のインスタンスは破棄しないようにしてください。

必要ファイル: TnbAccessor.h

日付: 06/06/08 新規作成; 06/10/31 メンバ追加; 09/04/02 HWND にも対応; 09/11/12 WriteData() を追加。; 10/05/17 シリアライザーを追加。

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

構築子と解体子

◆ CSection()

CSection	(	const IAccessor *	I,
		LPCTSTR	lpszSectionName
	)

代入コンストラクタ

引数

I	IAccessor を持つインスタンスオブジェクト
lpszSectionName	本クラスで扱うセクション名

例外

CNullPointerException IAccessorクラスを指定しないとスローされます。

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

関数詳解

◆ CanQuery()

bool CanQuery ( void ) const

[確認] 参照可能？そのセクションが存在し読み込める、確認できます。

戻り値

true	存在。
false	ない。

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

◆ DeleteAllKeys()

bool DeleteAllKeys ( void )

[削除] 全キー削除

戻り値

true	成功
false	失敗

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

◆ DeleteKey()

bool DeleteKey ( LPCTSTR lpszKey )

[削除] 指定キー削除

引数

lpszKey キー名。

戻り値

true	成功
false	失敗

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

◆ EnumKeyNames()

CStrVector EnumKeyNames ( void ) const

[取得] キー名一覧取得

戻り値: キー名一覧

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

◆ EnumSectionNames()

CStrVector EnumSectionNames ( void ) const

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

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

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

◆ GetKeyKind()

EKind GetKeyKind ( LPCTSTR lpszKey ) const

[取得] 情報取種取得

引数

lpszKey キー名

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

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

◆ GetKeyMap()

CKeyMap GetKeyMap ( void ) const

[取得] 全値取得

覚え書き: 全キーと値をマップに格納します。

戻り値: マップ

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

◆ GetKeyTree() [1/2]

void GetKeyTree ( CKeyTree & _tree ) const

[取得] 全値取得

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

引数

[out] _tree ツリー

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

◆ GetKeyTree() [2/2]

void GetKeyTree ( CStrsTree & _tree ) const

[取得] 全値取得

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

引数

[out] _tree ツリー

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

◆ GetSectionName()

CStr GetSectionName ( void ) const

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

戻り値: セクション名

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

◆ HasKey()

bool HasKey ( LPCTSTR lpszKey ) const

[確認] 情報存在確認

引数

lpszKey キー名

戻り値

true	情報あり。
false	情報無し。

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

◆ InSubSection()

bool InSubSection ( LPCTSTR lpszSubName )

[設定] 対象セクション変更.

指定のサブセクションを追加し、取得対象をそのセクション内にします。

引数

lpszSubName サブセクション名。

戻り値

true	成功
false	失敗（名前に￥が含まれている、など）

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

◆ PreviousSubSection()

void PreviousSubSection ( void )

[設定] 対象セクション変更.

取得対象を一つ上のセクション内ににします。

覚え書き: IsSubSection() と対になるように使用します。

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

◆ QueryData()

CByteVector QueryData ( LPCTSTR lpszKey ) const

[取得] バイナリ情報取得

引数

lpszKey キー名

戻り値: キーの値

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

◆ QueryDword()

DWORD QueryDword	(	LPCTSTR	lpszKey,
		DWORD	dwDefault = `0`
	)		const

[取得] 数値情報取得

引数

lpszKey	キー名
dwDefault	キーがない時この値を返します。省略すると０です。

戻り値: キーの値

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

◆ QueryLonglong()

LONGLONG QueryLonglong	(	LPCTSTR	lpszKey,
		LONGLONG	llDefault = `0`
	)		const

[取得] 数値情報取得

引数

lpszKey	キー名
llDefault	キーがない時この値を返します。省略すると０です。

戻り値: キーの値

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

◆ QueryPluralStrings()

CStrVector QueryPluralStrings ( LPCTSTR lpszKey ) const

[取得] 文字列群情報取得

引数

lpszKey キー名

戻り値: キーの値

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

◆ QuerySerializableData()

bool QuerySerializableData	(	LPCTSTR	lpszKey,
		ISerializable &	_d
	)		const

[取得] シリアライザブルデータ情報取得

引数

[in]	lpszKey	キー名
[out]	_d	デシリアライズした結果が格納されます。

戻り値

true	成功
false	失敗

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

◆ QueryString()

CStr QueryString	(	LPCTSTR	lpszKey,
		LPCTSTR	lpszDefault = `NULL`
	)		const

[取得] 文字列情報取得

引数

lpszKey	キー名
lpszDefault	キーがない時この値を返します。省略すると Empty文字列です。

戻り値: キーの値

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

◆ QueryStruct()

bool QueryStruct	(	LPCTSTR	lpszKey,
		TYP &	_t
	)		const

[取得] バイナリ情報取得

覚え書き: 構造体のメモリイメージを取得します。

注意: 構造体は、 Plain Old Data (POD) 型である必要があります。

引数

[in]	lpszKey	キー名
[out]	_t	キーの値

戻り値

true	成功。
false	失敗。情報サイズが異なる。

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

◆ QueryValue()

CValue QueryValue ( LPCTSTR lpszKey ) const

[取得] 情報取得

引数

lpszKey キー名

戻り値: キーの値

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

◆ QueryVector()

CVectorT< CValue > QueryVector ( void ) const

[取得] 配列値取得

覚え書き: WriteVector() による書き込んだ配列値を取得します。

戻り値: 配列

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

◆ QueryWindowText()

bool QueryWindowText	(	LPCTSTR	lpszKey,
		HWND	hWnd,
		LPCTSTR	lpszDefault = `NULL`
	)		const

[取得] ウィンドウテキスト情報取得

引数

lpszKey	キー名
hWnd	ウィンドウハンドル
lpszDefault	キーがない時この値を返します。省略すると Empty文字列です。

戻り値

true	成功。
false	失敗。

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

◆ ReferAccessor()

const IAccessor * ReferAccessor ( void ) const

[参照] Accessorインターフェース参照

戻り値: IAccessor

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

◆ WriteData() [1/2]

bool WriteData	(	LPCTSTR	lpszKey,
		const IConstCollectionT< BYTE > &	c
	)

[追加] バイナリ情報記録

引数

lpszKey	キー名
c	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteData() [2/2]

bool WriteData	(	LPCTSTR	lpszKey,
		size_t	len,
		LPCVOID	P
	)

[追加] バイナリ情報記録

引数

lpszKey	キー名
len	キーの値(データサイズ)
P	キーの値(データ)

戻り値

true	成功
false	失敗

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

◆ WriteDword()

bool WriteDword	(	LPCTSTR	lpszKey,
		DWORD	dwValue
	)

[追加] 数値情報記録

引数

lpszKey	キー名
dwValue	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteLonglong()

bool WriteLonglong	(	LPCTSTR	lpszKey,
		LONGLONG	llValue
	)

[追加] 数値情報記録

引数

lpszKey	キー名
llValue	キーの値

戻り値

true	成功
false	失敗

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

◆ WritePluralStrings()

bool WritePluralStrings	(	LPCTSTR	lpszKey,
		const CStrVector &	vs
	)

[追加] 文字列群情報記録

引数

lpszKey	キー名
vs	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteSerializableData()

bool WriteSerializableData	(	LPCTSTR	lpszKey,
		const ISerializable &	s
	)

[追加] シリアライザブルデータ情報記録

引数

lpszKey	キー名
s	シリアライズ可能のデータ

戻り値

true	成功
false	失敗

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

◆ WriteString()

bool WriteString	(	LPCTSTR	lpszKey,
		LPCTSTR	lpszValue
	)

[追加] 文字列情報記録

引数

lpszKey	キー名
lpszValue	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteStruct()

bool WriteStruct	(	LPCTSTR	lpszKey,
		const TYP &	t
	)

[追加] バイナリ情報記録

覚え書き: 構造体のメモリイメージを記録します。

注意: 構造体は、 Plain Old Data (POD) 型である必要があります。

引数

lpszKey	キー名
t	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteValue()

bool WriteValue	(	LPCTSTR	lpszKey,
		const CValue &	value
	)

[追加] 情報記録

引数

lpszKey	キー名
value	キーの値

戻り値

true	成功
false	失敗

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

◆ WriteVector()

bool WriteVector ( const CVectorT< CValue > & vv )

[追加] 配列値記録

覚え書き: 配列を記録します。セクション以下を一度消去し、配列数と値を記録します。

引数

vv 配列

戻り値

true	成功
false	失敗

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

◆ WriteWindowText()

bool WriteWindowText	(	LPCTSTR	lpszKey,
		HWND	hWnd
	)

[追加] ウィンドウテキスト情報記録

引数

lpszKey	キー名
hWnd	ウィンドウハンドル

戻り値

true	成功
false	失敗

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

公開メンバ関数

詳解

構築子と解体子

◆ CSection()

関数詳解

◆ CanQuery()

◆ DeleteAllKeys()

◆ DeleteKey()

◆ EnumKeyNames()

◆ EnumSectionNames()

◆ GetKeyKind()

◆ GetKeyMap()

◆ GetKeyTree() [1/2]

◆ GetKeyTree() [2/2]

◆ GetSectionName()

◆ HasKey()

◆ InSubSection()

◆ PreviousSubSection()

◆ QueryData()

◆ QueryDword()

◆ QueryLonglong()

◆ QueryPluralStrings()

◆ QuerySerializableData()

◆ QueryString()

◆ QueryStruct()

◆ QueryValue()

◆ QueryVector()

◆ QueryWindowText()

◆ ReferAccessor()

◆ WriteData() [1/2]

◆ WriteData() [2/2]

◆ WriteDword()

◆ WriteLonglong()

◆ WritePluralStrings()

◆ WriteSerializableData()

◆ WriteString()

◆ WriteStruct()

◆ WriteValue()

◆ WriteVector()

◆ WriteWindowText()