クラス Sapie::CConfigReader

アプリケーションコンフィグファイル読込クラス [詳細]

#include <ConfigReader.h>

Sapie::CConfigReaderに対する継承グラフ

Public メソッド
	CConfigReader (bool bReadFlg=true)
	コンストラクタ(アプリケーション指定なし)
	CConfigReader (std::string sAppName, bool bReadFlg)
	コンストラクタ(アプリケーション指定あり)
virtual	~CConfigReader ()
	デストラクタ
long	GetConfigValue (std::string sSectName, std::string sConfName, std::string &sValue)
	指定した値を取得する
long	ReadConfig ()
	設定ファイルを読み込む
long	GetAppInfo (AppBaseInfo &appInfo)
	アプリケーションの基本的な情報を取得する

---

説明

アプリケーションコンフィグファイル読込クラス

---

コンストラクタとデストラクタ

Sapie::CConfigReader::CConfigReader

(

bool

bReadFlg = true

)

コンストラクタ(アプリケーション指定なし)

bReadFlg が true の場合、自アプリケーションのコンフィグファイルを 読み込み、このインスタンスが破棄されるまでメモリ上に保持する。

引数:

[in]

bReadFlg

コンフィグファイルを読みこむか。trueの場合コンフィグファイルを読み込む。

Sapie::CConfigReader::CConfigReader	(	std::string	sAppName,
		bool	bReadFlg
	)

コンストラクタ(アプリケーション指定あり)

bReadFlg が true の場合、sAppName で指定されたアプリケーションの コンフィグファイルを読み込み、このインスタンスが破棄されるまで メモリ上に保持する。

引数:

[in]	sAppName	アプリケーション名
[in]	bReadFlg	コンフィグファイルを読みこむか。trueの場合コンフィグファイルを読み込む。

virtual Sapie::CConfigReader::~CConfigReader

(

)

[virtual]

デストラクタ

コンフィグファイルを読み込んだメモリを解放し、このインスタンスを破棄する

---

関数

long Sapie::CConfigReader::GetConfigValue	(	std::string	sSectName,
		std::string	sConfName,
		std::string &	sValue
	)

指定した値を取得する

コンフィグファイルから、sSectName と sConfName で指定された項目の値を 取得し、sValue に設定する。

注意:

コンストラクタまたはReadConfig()にて、事前にコンフィグファイルをメモリ

上に読み込んでおく必要がある。

引数:

[in]	sSectName	セクション名
[in]	sConfName	設定項目名
[out]	sValue	設定値

戻り値:

常に 0 を返す。取得できな場合は、sValueにNull文字列を設定する。

long Sapie::CConfigReader::ReadConfig

(

)

設定ファイルを読み込む

自アプリケーションまたはコンストラクタで指定されたアプリケーションの コンフィグファイルを読み込み、 このインスタンスが破棄されるまでメモリ上に保持する。

戻り値:

正常に読み込めた場合は 0 を返す。異常終了した場合は -1 を返す。

long Sapie::CConfigReader::GetAppInfo

(

AppBaseInfo &

appInfo

)

アプリケーションの基本的な情報を取得する

自アプリケーションまたはコンストラクタで指定されたアプリケーションの コンフィグファイル基本情報を取得する。

注意:

コンストラクタまたはReadConfig()にて、事前にコンフィグファイルをメモリ

上に読み込んでおく必要がある。

引数:

[out]

appInfo

アプリケーション情報

戻り値:

正常に取得できた場合は 0 を返す。異常終了した場合は -1 を返す。

---

このクラスの説明は次のファイルから生成されました:

• ConfigReader.h