CmnConf.h ファイル

設定値操作 共通関数 I/Fヘッダファイル [詳解]

#include "cmnclib/Common.h"

[ソースコード]

データ構造
struct	tag_CmnConf_PropertyList

型定義
typedef struct tag_CmnConf_PropertyList	CmnConfProperty

関数
D_EXTERN int	CmnConf_GetEnv (char *buf, const char *envName)
	環境変数取得 [詳解]
D_EXTERN CmnConfProperty *	CmnConfProperty_Load (const char *file)
	プロパティリスト取得 [詳解]
D_EXTERN void	CmnConfProperty_Free (CmnConfProperty *list)
	プロパティ値取得 [詳解]
D_EXTERN char *	CmnConfProperty_GetValue (const CmnConfProperty *list, const char *name)
	プロパティ値取得 [詳解]

詳解

設定値操作 共通関数 I/Fヘッダファイル

設定値操作系共通関数を使用するためのI/Fヘッダファイル。
設定値操作系の共通関数を使用する場合は、このヘッダファイルを読み込むこと

著者

H.Kumagai

日付

2004-06-04

Revision

1.1

型定義詳解

typedef struct tag_CmnConf_PropertyList CmnConfProperty

プロパティリスト。プロパティファイルの情報を全て格納する。

関数詳解

D_EXTERN int CmnConf_GetEnv	(	char *	buf,
		const char *	envName
	)

環境変数取得

環境変数envNameに設定されている値を取得する。

引数

buf	(O) 取得した値を設定する。値が取得できなかった場合は何もしない。 関数コール元で十分なバッファ領域を確保すること。
envName	(I) 値を取得する環境変数名

戻り値

True	環境変数が取得できた場合
False	環境変数が取得できなかった場合

著者

H.Kumagai

D_EXTERN void CmnConfProperty_Free

(

CmnConfProperty *

list

)

プロパティ値取得

プロパティリストのメモリ領域を解放する。

引数

list	(I) 解放するプロパティリスト

著者

H.Kumagai

D_EXTERN char* CmnConfProperty_GetValue	(	const CmnConfProperty *	list,
		const char *	name
	)

プロパティ値取得

nameに指定されたプロパティ値をlistから取得する

引数

list	(I) プロパティリスト（CmnConf_GetPropertyList関数の戻り値）
name	(I) 取得するプロパティ名

戻り値

プロパティ値文字列へのポインタ。nameに該当が無い場合はNULLを返す。

著者

H.Kumagai

D_EXTERN CmnConfProperty* CmnConfProperty_Load

(

const char *

file

)

プロパティリスト取得

プロパティファイルの読み込みを行い、 CmnConf_PropertyList構造体にプロパティリストを格納する。
プロパティリストの使用が終了したらCmnConf_FreePropertyList関数をコールし、 メモリ領域の解放を行うこと。

引数

file	(I)プロパティ定義ファイル（フルパスで指定すること）

戻り値

取得したプロパティリスト(CmnConf_PropertyList)へのポインタ。
プロパティの取得に失敗した場合はNULLを返す。

著者

H.Kumagai