介绍

INI配置文件读写类 该类提供了读取、写入和操作INI格式配置文件的功能[1,2](。 INI文件由节(Section)、键(Key)和值(Value)组成，格式如下： [SectionName] Key1=Value1 Key2=Value2[1,2](

基础信息

头文件:	include <TpConfig.h>
Cmake:	None
发布版本:	V0.2.1
继承类:
派生类:

Public 类型

enum TpConfig::Status

名称	值	描述
NoError	0	无异常；正常读写
AccessError	1	权限错误；文件访问失败
FormatError	2	格式化错误；文件格式非INI格式或格式有误

Public 成员函数

	TpConfig()	默认构造函数
	TpConfig(const TpString &fileName)	构造函数，同时加载指定INI文件
	~TpConfig()	析构函数
	load(const TpString &fileName)	加载指定的INI文件
TpString	fileName() const	获取当前关联的INI文件名
	clear()	清除所有配置数据
	sync()	将内存中的配置数据同步到文件
Status	status() const	获取当前操作状态
	beginGroup(const TpString &prefix)	开始一个配置组（节）
	endGroup()	结束当前配置组
TpString	group() const	获取当前组路径
TpVector< TpString >	allKeys() const	获取所有键名（包含完整组路径）
TpVector< TpString >	childKeys() const	获取当前组下的所有键名
TpVector< TpString >	childGroups() const	获取当前组下的所有子组名
	isWritable() const	检查文件是否可写
	setValue(const TpString &key, const TpString &value)	设置指定键的值
TpString	value(const TpString &key) const	获取指定键的值
	remove(const TpString &key)	移除指定键
	contains(const TpString &key) const	检查是否包含指定键

成员函数说明

TpConfig::TpConfig()

默认构造函数...

默认构造函数

TpConfig::TpConfig(const TpString &fileName)

构造函数，同时加载指定INI文件...

构造函数，同时加载指定INI文件
参数：fileName: 要加载的INI文件路径

virtual TpConfig::~TpConfig()

析构函数...

析构函数

bool TpConfig::load(const TpString &fileName)

加载指定的INI文件...

加载指定的INI文件
参数：fileName: 要加载的INI文件路径
返回值：成功加载返回true，否则返回false

TpString TpConfig::fileName() const

获取当前关联的INI文件名...

获取当前关联的INI文件名
返回值：当前关联的文件名

void TpConfig::clear()

清除所有配置数据...

清除所有配置数据

void TpConfig::sync()

将内存中的配置数据同步到文件...

将内存中的配置数据同步到文件

Status TpConfig::status() const

获取当前操作状态...

获取当前操作状态
返回值：当前状态值

void TpConfig::beginGroup(const TpString &prefix)

开始一个配置组（节）...

开始一个配置组（节）
参数：prefix: 组名前缀，实际节名为当前组路径+prefix

void TpConfig::endGroup()

结束当前配置组...

结束当前配置组

TpString TpConfig::group() const

获取当前组路径...

获取当前组路径
返回值：当前组路径字符串

TpVector< TpString > TpConfig::allKeys() const

获取所有键名（包含完整组路径）...

获取所有键名（包含完整组路径）
返回值：包含所有键名的向量

TpVector< TpString > TpConfig::childKeys() const

获取当前组下的所有键名...

获取当前组下的所有键名
返回值：包含当前组下所有键名的向量

TpVector< TpString > TpConfig::childGroups() const

获取当前组下的所有子组名...

获取当前组下的所有子组名
返回值：包含当前组下所有子组名的向量

bool TpConfig::isWritable() const

检查文件是否可写...

检查文件是否可写
返回值：文件可写返回true，否则返回false

void TpConfig::setValue(const TpString &key, const TpString &value)

设置指定键的值...

设置指定键的值
参数：key: 键名（支持组路径，如"Group/Key"）
参数：value: 要设置的值

TpString TpConfig::value(const TpString &key) const

获取指定键的值...

获取指定键的值
参数：key: 键名（支持组路径，如"Group/Key"）
返回值：键对应的值，不存在时返回空

void TpConfig::remove(const TpString &key)

移除指定键...

移除指定键
参数：key: 要移除的键名

bool TpConfig::contains(const TpString &key) const

检查是否包含指定键...

检查是否包含指定键
参数：key: 要检查的键名
返回值：存在返回true，否则返回false

版权所有

版权归属：TinyPiXOS

许可证：署名-相同方式共享 4.0 国际 (CC-BY-SA-4.0)