csh
b6160676b4
Move generated builtin and dotnet function docs into the upgraded taxonomy, remove legacy route pages, and regenerate function_index.tsv from markdown headings.
322 lines
15 KiB
Markdown
322 lines
15 KiB
Markdown
# 运行时 / INI配置
|
||
|
||
### `iniDeleteKey(alias, file_name, section, ident)`
|
||
|
||
删除INI中的标识符。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件中的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件中要删除的键名称 |
|
||
|
||
返回：any
|
||
|
||
### `iniEraseSection(alias, file_name, section)`
|
||
|
||
删除INI中的段。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------------- |
|
||
| `alias` | string | 字符串类型，目录名称； |
|
||
| `file_name` | string | 字符串类型，INI文件名称； |
|
||
| `section` | string | 字符串类型，INI文件的节名称； |
|
||
|
||
返回：any
|
||
|
||
### `iniReadBinaryStream(alias, file_name, section, ident, _type)`
|
||
|
||
从INI中读stream类型内容，读取后的内容支持数组，字符串，二进制流以及stream类型进行输出
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------------- |
|
||
| `alias` | string | 字符串类型。参考目录别名。 |
|
||
| `file_name` | string | 字符串类型。INI文件名称。 |
|
||
| `section` | string | 字符串类型。INI文件中的节点名称。 |
|
||
| `ident` | string | 字符串类型。INI文件中的键名称。 |
|
||
| `_type` | string | TStream |
|
||
|
||
返回：string
|
||
|
||
### `iniReadBool(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读Bool类型。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | bool | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | object |
|
||
|
||
返回：bool
|
||
|
||
### `iniReadDate(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读日期类型。 老版客户端中，支持读yyyy/mm/dd的日期格式，新版本客户端支持yyyy-mm-dd的日期格式，与其它函数日期格式表现一致。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | -------- | ----------------------------------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | datetime | 字符串类型。INI文件名称 |
|
||
| `section` | any | 字符串类型。INI文件的节名称 |
|
||
| `ident` | any | 字符串类型。INI文件的键名称 |
|
||
| `_default` | any | 日期类型。获取失败时返回的替代值，默认的INI文件的键值 |
|
||
|
||
返回：datetime
|
||
|
||
### `iniReadDateTime(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读日期时间类型。 老版客户端中，支持读yyyy/mm/dd hh:nn:ss的日期格式，新版本客户端支持yyyy-mm-dd hh:nn:ss的日期格式，与其它函数日期格式表现一致。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | -------- | --------------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | datetime | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | 日期时间类型。默认的INI文件的键值 |
|
||
|
||
返回：datetime
|
||
|
||
### `iniReadFloat(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读浮点类型。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | float | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | 浮点类型。默认的INI文件的键值 |
|
||
|
||
返回：float
|
||
|
||
### `iniReadInteger(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读整数类型。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | int | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | 整数类型。默认的INI文件的键值 |
|
||
|
||
返回：int
|
||
|
||
### `iniReadSection(alias, file_name, section)`
|
||
|
||
从INI中读出一个节点中所有键名称。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
|
||
返回：array
|
||
|
||
### `iniReadSections(alias, file_name)`
|
||
|
||
从INI中读出所有的节名称。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
|
||
返回：array
|
||
|
||
### `iniReadSectionsw(alias, file_name)`
|
||
|
||
从INI中读出所有的节名称，其中，名称字符串为宽字节字符串，IniReadSections返回的名称字符串为多字节字符串。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
|
||
返回：array
|
||
|
||
### `iniReadSectionValues(alias, file_name, section)`
|
||
|
||
从INI中读指定节所有的键的值。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
|
||
返回：array
|
||
|
||
### `iniReadString(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读字符类型。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ----------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件的名称 |
|
||
| `section` | string | 字符串类型。InI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | 字符串类型。INI文件默认的键值 |
|
||
|
||
返回：string
|
||
|
||
### `iniReadTime(alias, file_name, section, ident, _default)`
|
||
|
||
从INI中读时间类型。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | TTime | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `_default` | string | 时间类型。INI文件默认的键值 |
|
||
|
||
返回：TTime
|
||
|
||
### `iniSectionExists(alias, file_name, section)`
|
||
|
||
判断INI中的节名称是否存在。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
|
||
返回：bool
|
||
|
||
### `iniValueExists(alias, file_name, section, ident)`
|
||
|
||
判断INI中的指定的节名称下的键名称是否有值。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
|
||
返回：bool
|
||
|
||
### `iniWriteBinaryStream(alias, file_name, section, ident, value)`
|
||
|
||
将数据转成数据流写入INI文件中。支持写入数组，字符串，binary，stream类型等。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将字节流Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | ------------------------------- |
|
||
| `alias` | string | 字符串类型。参考目录别名。 |
|
||
| `file_name` | string | 字符串类型。INI文件名称。 |
|
||
| `section` | string | 字符串类型。INI文件中的节名称。 |
|
||
| `ident` | string | 字符串类型。INI文件中的键名称。 |
|
||
| `value` | string | Integer\\ |
|
||
|
||
返回：int
|
||
|
||
### `iniWriteBool(alias, file_name, section, ident, value)`
|
||
|
||
将BOOL值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将Bool值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | bool | object |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteDate(alias, file_name, section, ident, value)`
|
||
|
||
将日期值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将日期值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | -------- | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | datetime | 日期类型。要写入的日期值 |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteDateTime(alias, file_name, section, ident, value)`
|
||
|
||
将日期时间值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将日期时间值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | -------- | -------------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | datetime | 日期时间类型。要写入的日期时间值 |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteFloat(alias, file_name, section, ident, value)`
|
||
|
||
将浮点值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将浮点值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | float | 浮点类型。要写入的浮点数值 |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteInteger(alias, file_name, section, ident, value)`
|
||
|
||
将整数值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将整数值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | float | 整数类型。要写入的整数值 |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteString(alias, file_name, section, ident, value)`
|
||
|
||
将字符串值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将字符串Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | ------ | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | string | 字符串类型。要写入的字符串 |
|
||
|
||
返回：string
|
||
|
||
### `iniWriteTime(alias, file_name, section, ident, value)`
|
||
|
||
将时间值写入INI。如果不存在FileName，或者不存在Section，或者不存在Ident，则其会根据输入的FileName，Section，Ident创建对应的INI文件，INI文件的节名称，INI文件的键名称，并将时间值Value写入到INI文件指定的键
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| ----------- | -------- | --------------------------- |
|
||
| `alias` | string | 字符串类型。目录名称 |
|
||
| `file_name` | string | 字符串类型。INI文件名称 |
|
||
| `section` | string | 字符串类型。INI文件的节名称 |
|
||
| `ident` | string | 字符串类型。INI文件的键名称 |
|
||
| `value` | datetime | 时间类型。要写入的时间值 |
|
||
|
||
返回：string
|