readconf  1.6
設定ファイル読み込みモジュール
 全て データ構造 ファイル 関数 変数 型定義 列挙型 列挙型の値 マクロ定義 グループ
データ構造 | 型定義 | 列挙型 | 関数
設定ファイル読み込みモジュール

データ構造

union  RCConfValue
 設定項目値の共用体。 [詳細]
 
struct  RCConfItem
 設定項目の構造体。 [詳細]
 

型定義

typedef enum RCValueType RCValueType
 設定項目の型ID。 [詳細]
 
typedef union RCConfValue RCConfValue
 設定項目値の共用体。 [詳細]
 
typedef struct RCConfItem RCConfItem
 設定項目の構造体。 [詳細]
 

列挙型

enum  RCValueType { RCValueTypeString = 'S', RCValueTypeInteger = 'I', RCValueTypeReal = 'D', RCValueTypeBool = 'B' }
 設定項目の型ID。 [詳細]
 

関数

bool readconf (RCConfItem *items, size_t numItems, const char *confPath)
 指定の設定ファイルから設定を読み込み、指定された構造体配列に格納します。 [詳細]
 
void RCFreeStringValueInItems (RCConfItem *items, size_t numItems)
 指定された設定項目構造体配列の文字列を解放します。 [詳細]
 
void RCFreeRaisedErrors (void)
 readconf() による読み込み処理で発生したエラー情報構造体配列を解放します。 [詳細]
 

説明

型定義

typedef struct RCConfItem RCConfItem

設定項目の構造体。

この構造体は、 readconf() が読み込むべき設定項目の名前と デフォルト値を指定するのに、アプリケーションによって使用されます。 また、読み込んだ設定項目の値を格納する場所としても readconf() によって使用されます。

typedef union RCConfValue RCConfValue

設定項目値の共用体。

typedef enum RCValueType RCValueType

設定項目の型ID。

列挙型

設定項目の型ID。

列挙型の値
RCValueTypeString 

文字列型。

RCValueTypeInteger 

整数型(long)。

RCValueTypeReal 

実数型(double)。

RCValueTypeBool 

真偽値型(bool)。

readconf.h27 行で定義されています。

関数

void RCFreeRaisedErrors ( void  )

readconf() による読み込み処理で発生したエラー情報構造体配列を解放します。

readconf.c145 行で定義されています。

参照先 RCNumRaisedErrors, と RCRaisedErrorArrayCapacity.

void RCFreeStringValueInItems ( RCConfItem items,
size_t  numItems 
)

指定された設定項目構造体配列の文字列を解放します。

設定項目構造体が表す型が文字列の場合に、文字列を解放します。 解放した後は NULL を設定します。

引数
[in,out]items解放すべき文字列が格納された設定項目構造体配列。
[in]numItems構造体配列 items の項目数。

readconf.c129 行で定義されています。

参照先 RCConfItem::defaultValue, RCValueTypeString, RCConfValue::string, と RCConfItem::value.

bool readconf ( RCConfItem items,
size_t  numItems,
const char *  confPath 
)

指定の設定ファイルから設定を読み込み、指定された構造体配列に格納します。

設定ファイルから読み込みたい項目名と、 項目を読み込めなかった際のデフォルト値を指定して本関数を呼び出します。 本関数は設定ファイルを読み込んで、指定された項目に対応する値を設定します。

引数
[in,out]items読み込むべき設定項目の名前とデフォルト値を設定した 構造体配列へのポインタ。 読み込んだ設定項目の値を格納するのにも使用されます。
[in]numItems構造体配列 items の項目数。
[in]confPath読み込む設定ファイルへのパス。
戻り値
読み込みに成功したら true、読み込み時にエラーがあったら false。

readconf.c96 行で定義されています。

参照先 addError(), initialize(), RCErrorNoItem, RCErrorNullItem, RCErrorOpen, RCNumRaisedErrors, と readConf().

関数の呼び出しグラフ: