暗号ファイル情報アクセスクラス [詳解]

#include <TnbCipherableFileAccessor.h>

CCipherableFileAccessor の継承関係図

公開型
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' }
	値型の種類. [詳解]

公開メンバ関数
	CCipherableFileAccessor (LPCTSTR lpszFileName, LPCTSTR lpszHeadText, LPCTSTR lpszKey)
	コンストラクタ [詳解]

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

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

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

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

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

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

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

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

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

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

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

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

void	SetBase (LPCTSTR lpszFileName, LPCTSTR lpszHeadText, LPCTSTR lpszKey)
	[設定] ベース指定 [詳解]

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

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

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

限定公開変数類
CMapT< CStr, CKeyMap, LPCTSTR >	m_mapSec
	セクションマップ [詳解]

詳解

暗号ファイル情報アクセスクラス

セクションで区切られた中に複数のキーと値を持つ形の情報をメモリで管理し、
任意のタイミングで、ファイルに保存しておき、次回情報を復元することが
出来るクラスです。このファイルは、暗号化されており、また、CRCも付加して
あるため、保存情報を参照禁止、改ざん禁止したい場合に使用できます。

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

注意: Write〜() で情報を変更しても、 Flush() をコールしない限りファイルに書き出しません。

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

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

必要ファイル: TnbCipherableFileAccessor.h

日付: 06/06/12 新規作成

TnbCipherableFileAccessor.h の 50 行目に定義があります。

型定義メンバ詳解

◆ 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 行目に定義があります。

構築子と解体子

◆ CCipherableFileAccessor()

CCipherableFileAccessor	(	LPCTSTR	lpszFileName,
		LPCTSTR	lpszHeadText,
		LPCTSTR	lpszKey
	)

explicit

コンストラクタ

引数

lpszFileName	ファイル名
lpszHeadText	ヘッダ文字列
lpszKey	暗号キー

例外

CNotSupportException	指定ファイルのヘッダ形状が異なるとスローされます。
CInvalidParamException	指定ファイルのファイル長さが異なるとスローされます。
CNoSuchTypeException	指定ファイルのチェックサムが異なるとスローされます。
CReadFailureException	指定ファイルの読み込みに失敗するとスローされます。

TnbCipherableFileAccessor.h の 101 行目に定義があります。

関数詳解

◆ DeleteAllSection()

bool DeleteAllSection ( void )

inherited

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

戻り値

true	成功
false	失敗

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

◆ DeleteSection()

virtual bool DeleteSection ( LPCTSTR lpszSectionName )

virtualinherited

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

引数

lpszSectionName セクション名。

戻り値

true	成功
false	失敗

IAccessorを実装しています。

TnbTemporaryAccessor.h の 220 行目に定義があります。

◆ EnumKeyNames()

virtual CStrVector EnumKeyNames ( LPCTSTR lpszSectionName ) const

virtualinherited

[取得] キー名一覧取得

引数

lpszSectionName セクション名

戻り値: キー名一覧。

IAccessorを実装しています。

TnbTemporaryAccessor.h の 244 行目に定義があります。

◆ EnumSectionNames()

virtual CStrVector EnumSectionNames ( LPCTSTR lpszSectionName = NULL ) const

virtualinherited

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

引数

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

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

IAccessorを実装しています。

TnbTemporaryAccessor.h の 169 行目に定義があります。

◆ Flush()

virtual bool Flush ( void )

virtual

[操作] フラッシュ.

覚え書き: コンストラクタや SetBase で指定したファイルに変更を書き出します。このメソッドをコールしない限り、ファイルは変化しません。

戻り値

true	成功
false	失敗

CTemporaryAccessorを再実装しています。

TnbCipherableFileAccessor.h の 145 行目に定義があります。

◆ GetKeyKind()

virtual EKind GetKeyKind	(	LPCTSTR	lpszSectionName,
		LPCTSTR	lpszKey
	)		const

virtualinherited

[取得] 情報取種取得

引数

lpszSectionName	セクション名
lpszKey	キー名

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

IAccessorを実装しています。

TnbTemporaryAccessor.h の 257 行目に定義があります。

◆ 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

[取得] タイプ名取得

戻り値: タイプ名

CTemporaryAccessorを再実装しています。

TnbCipherableFileAccessor.h の 133 行目に定義があります。

◆ MakeDefineFilePath()

static CStr MakeDefineFilePath ( void )

staticinherited

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

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

戻り値: フルパス

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

◆ 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

virtualinherited

[取得] 情報取得

引数

lpszSectionName	セクション名
lpszKey	キー名

戻り値: キーの値

IAccessorを実装しています。

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

◆ SetBase()

void SetBase	(	LPCTSTR	lpszFileName,
		LPCTSTR	lpszHeadText,
		LPCTSTR	lpszKey
	)

[設定] ベース指定

引数

lpszFileName	ファイル名
lpszHeadText	ヘッダ文字列
lpszKey	暗号キー

例外

CNotSupportException	指定ファイルのヘッダ形状が異なるとスローされます。
CInvalidParamException	指定ファイルのファイル長さが異なるとスローされます。
CNoSuchTypeException	指定ファイルのチェックサムが異なるとスローされます。
CReadFailureException	指定ファイルの読み込みに失敗するとスローされます。

TnbCipherableFileAccessor.h の 116 行目に定義があります。

◆ 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
	)

virtualinherited

[設定] 情報設定

引数

lpszSectionName	セクション名
lpszKey	キー名
value	設定する値

戻り値

true	成功
false	失敗

IAccessorを実装しています。

TnbTemporaryAccessor.h の 295 行目に定義があります。

メンバ詳解

◆ m_mapSec

CMapT<CStr, CKeyMap, LPCTSTR> m_mapSec

mutableprotectedinherited

セクションマップ

TnbTemporaryAccessor.h の 55 行目に定義があります。

公開型

公開メンバ関数

静的公開メンバ関数

限定公開変数類

詳解

型定義メンバ詳解

◆ CKeyTree

列挙型メンバ詳解

◆ EKind

構築子と解体子

◆ CCipherableFileAccessor()

関数詳解

◆ DeleteAllSection()

◆ DeleteSection()

◆ EnumKeyNames()

◆ EnumSectionNames()

◆ Flush()

◆ GetKeyKind()

◆ GetKeyTree() [1/2]

◆ GetKeyTree() [2/2]

◆ GetTypeName()

◆ MakeDefineFilePath()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ QueryValue()

◆ SetBase()

◆ ToValueVector()

◆ WriteValue()

メンバ詳解

◆ m_mapSec