# Object - TIniFile INI 文件

## `TIniFile`

声明：class

用于读取和写入 INI 配置文件的内置对象

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database 创建 生成 构造函数 实例化 new -->

### `create(alias, file_name)`

声明：function

构造函数。打开指定目录别名和文件名对应的 INI 配置

<!-- tags: Object TIniFile INI 文件 创建 生成 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数        | 类型   | 说明       |
| ----------- | ------ | ---------- |
| `alias`     | string | 目录别名   |
| `file_name` | string | INI 文件名 |

### `deleteKey(section, ident)`

声明：function

删除指定的键

<!-- tags: Object TIniFile INI 文件 删除 移除 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                             |
| --------- | ------ | -------------------------------- |
| `section` | string | 字符串类型，要删除的键所在章节名 |
| `ident`   | string | 字符串类型，要删除的键名         |

返回：any

### `eraseSection(section)`

声明：function

删除章节

<!-- tags: Object TIniFile INI 文件 删除 移除 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                       |
| --------- | ------ | -------------------------- |
| `section` | string | 字符串类型，要删除的章节名 |

返回：any

### `readBinaryStream(section, ident, value)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明                        |
| --------- | ------- | --------------------------- |
| `section` | string  | 字符串类型，节名            |
| `ident`   | string  | 字符串类型，键值名          |
| `value`   | TStream | TStream类型，存贮读取的内容 |

返回：integer

### `readBool(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明                                |
| --------- | ------- | ----------------------------------- |
| `section` | string  | 字符串类型，节名                    |
| `ident`   | string  | 字符串类型，键值名                  |
| `default` | boolean | Boolean类型，当不存在的时候的默认值 |

返回：boolean

### `readDate(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                             |
| --------- | ------ | -------------------------------- |
| `section` | string | 字符串类型，节名                 |
| `ident`   | string | 字符串类型，键值名               |
| `default` | TDate  | 日期类型，当不存在的时候的默认值 |

返回：TDate

### `readDateTime(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型     | 说明                                 |
| --------- | -------- | ------------------------------------ |
| `section` | string   | 字符串类型，节名                     |
| `ident`   | string   | 字符串类型，键值名                   |
| `default` | datetime | 日期时间类型，当不存在的时候的默认值 |

返回：datetime

### `readFloat(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                             |
| --------- | ------ | -------------------------------- |
| `section` | string | 字符串类型，节名                 |
| `ident`   | string | 字符串类型，键值名               |
| `default` | float  | 实数类型，当不存在的时候的默认值 |

返回：float

### `readInteger(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明                             |
| --------- | ------- | -------------------------------- |
| `section` | string  | 字符串类型，节名                 |
| `ident`   | string  | 字符串类型，键值名               |
| `default` | integer | 整数类型，当不存在的时候的默认值 |

返回：integer

### `readSection(section, strings)`

声明：function

读取INI章节的所有键名

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型        | 说明                                  |
| --------- | ----------- | ------------------------------------- |
| `section` | string      | 字符串类型，节名                      |
| `strings` | TStringList | TStringList类型，用于存贮章节里的键名 |

返回：any

### `readSections(strings)`

声明：function

读取INI章节的所有章节名

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型        | 说明                          |
| --------- | ----------- | ----------------------------- |
| `strings` | TStringList | TStringList类型，用于存贮章名 |

返回：any

### `readSectionValues(section, strings)`

声明：function

读取INI章节的所有内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型        | 说明                                  |
| --------- | ----------- | ------------------------------------- |
| `section` | string      | 字符串类型，节名                      |
| `strings` | TStringList | TStringList类型，用于存贮章节里的内容 |

返回：any

### `readString(section, ident, default)`

声明：function

读取INI内容

<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                               |
| --------- | ------ | ---------------------------------- |
| `section` | string | 字符串类型，节名                   |
| `ident`   | string | 字符串类型，键值名                 |
| `default` | string | 字符串类型，当不存在的时候的默认值 |

返回：string

### `sectionExists(section)`

声明：function

判断是否存在指定章节名

<!-- tags: Object TIniFile INI 文件 判断 检查 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明             |
| --------- | ------ | ---------------- |
| `section` | string | 字符串类型，节名 |

返回：boolean

### `valueExists(section, ident)`

声明：function

判断是否存在指定的键

<!-- tags: Object TIniFile INI 文件 判断 检查 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明                             |
| --------- | ------ | -------------------------------- |
| `section` | string | 字符串类型，要查找的键所在章节名 |
| `ident`   | string | 字符串类型，要查找的键名         |

返回：boolean

### `writeBinaryStream(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明                |
| --------- | ------- | ------------------- |
| `section` | string  | 字符串类型，节名    |
| `ident`   | string  | 字符串类型，键值名  |
| `value`   | TStream | TStream类型，值内容 |

返回：any

### `writeBool(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明                |
| --------- | ------- | ------------------- |
| `section` | string  | 字符串类型，节名    |
| `ident`   | string  | 字符串类型，键值名  |
| `value`   | boolean | Boolean类型，值内容 |

返回：any

### `writeDate(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明               |
| --------- | ------ | ------------------ |
| `section` | string | 字符串类型，节名   |
| `ident`   | string | 字符串类型，键值名 |
| `value`   | TDate  | 日期类型，值内容   |

返回：any

### `writeDateTime(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型     | 说明                 |
| --------- | -------- | -------------------- |
| `section` | string   | 字符串类型，节名     |
| `ident`   | string   | 字符串类型，键值名   |
| `value`   | datetime | 日期时间类型，值内容 |

返回：any

### `writeFloat(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明               |
| --------- | ------ | ------------------ |
| `section` | string | 字符串类型，节名   |
| `ident`   | string | 字符串类型，键值名 |
| `value`   | float  | 实数类型，值内容   |

返回：any

### `writeInteger(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型    | 说明               |
| --------- | ------- | ------------------ |
| `section` | string  | 字符串类型，节名   |
| `ident`   | string  | 字符串类型，键值名 |
| `value`   | integer | 整数类型，值内容   |

返回：any

### `writeString(section, ident, value)`

声明：function

写入INI内容

<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->

可见性：public

| 参数      | 类型   | 说明               |
| --------- | ------ | ------------------ |
| `section` | string | 字符串类型，节名   |
| `ident`   | string | 字符串类型，键值名 |
| `value`   | string | 字符串类型，值内容 |

返回：any
