YStudio Y++

配置文件 INI（基础支持库）

Y++ / YStudio 开发文档 · 一点滴

扁平命令式支持库（不是类）。路径：支持库 → 基础支持库 → 配置文件。

硬约束

  1. 扁平命令读写 .ini 节/键；节名、键名区分大小写与否以实现为准。
  2. 读不到键时通常返回默认值参数（若签名提供）或空文本。
  3. 写配置会创建不存在的文件/节；注意路径权限。
  4. 与 ini-support 扩展文档可能互补；本页覆盖基础支持库面板命令。

快速开始

文本 ini = "G:/demo/app.ini"
// 写/读节键：命令名见签名表
输出(ini)

配置文件

本分类共 15 条。

INI_写

  • 签名：逻辑 INI_写(文本 文件路径, 文本 节, 文本 键, 文本 值)
  • 说明：便捷：直接写入文件一个键（缺文件则创建）。
  • 参数一│文件路径
  • 参数二│节
  • 参数三│键
  • 参数四│值

INI_写文件

  • 签名：逻辑 INI_写文件(整数 句柄, 文本 文件路径)
  • 说明：极速写入 UTF-8 INI 文件。
  • 参数一│句柄
  • 参数二│文件路径

INI_创建

  • 签名：整数 INI_创建()
  • 说明：创建空 INI 文档，成功返回句柄。

INI_删节

  • 签名：逻辑 INI_删节(整数 句柄, 文本 节)
  • 说明：删除整个节。
  • 参数一│句柄
  • 参数二│节

INI_删键

  • 签名：逻辑 INI_删键(整数 句柄, 文本 节, 文本 键)
  • 说明：删除键。
  • 参数一│句柄
  • 参数二│节
  • 参数三│键

INI_取值

  • 签名：文本 INI_取值(整数 句柄, 文本 节, 文本 键, [文本 默认=""])
  • 说明：取键值；不存在返回默认。
  • 参数一│句柄
  • 参数二│节
  • 参数三│键
  • 参数四│[默认]

INI_取节列表

  • 签名：文本数组 INI_取节列表(整数 句柄)
  • 说明：返回全部节名（文本数组）。
  • 参数一│句柄

INI_取错误

  • 签名：文本 INI_取错误()
  • 说明：取最近失败原因。

INI_取键列表

  • 签名：文本数组 INI_取键列表(整数 句柄, 文本 节)
  • 说明：返回指定节下全部键名（文本数组）。
  • 参数一│句柄
  • 参数二│节

INI_置值

  • 签名：逻辑 INI_置值(整数 句柄, 文本 节, 文本 键, 文本 值)
  • 说明：设置键值（节/键不存在则创建）。
  • 参数一│句柄
  • 参数二│节
  • 参数三│键
  • 参数四│值

INI_节是否存在

  • 签名：逻辑 INI_节是否存在(整数 句柄, 文本 节)
  • 说明：节是否存在。
  • 参数一│句柄
  • 参数二│节

INI_读

  • 签名：文本 INI_读(文本 文件路径, 文本 节, 文本 键, [文本 默认=""])
  • 说明：便捷：直接从文件读一个键（内部打开→取值→关闭）。
  • 参数一│文件路径
  • 参数二│节
  • 参数三│键
  • 参数四│[默认]

INI_读文件

  • 签名：整数 INI_读文件(文本 文件路径)
  • 说明：极速读取 UTF-8 INI 文件，成功返回句柄。
  • 参数一│文件路径

INI_释放

  • 签名：逻辑 INI_释放(整数 句柄)
  • 说明：释放句柄。
  • 参数一│句柄

INI_键是否存在

  • 签名：逻辑 INI_键是否存在(整数 句柄, 文本 节, 文本 键)
  • 说明：键是否存在。
  • 参数一│句柄
  • 参数二│节
  • 参数三│键

配置

本分类共 12 条。

修改配置

  • 签名：逻辑 修改配置(文本 文件路径, 文本 节名, 文本 键名, 文本 新值)
  • 说明：写入/覆盖 INI 中指定节、键的值（不存在则创建）。功能与「写配置项」相同，命令名侧重表达“改已有配置”。
  • 参数一│文件路径: INI 路径
  • 参数二│节名: 节名
  • 参数三│键名: 键名
  • 参数四│新值: 新文本值

写JSON

  • 签名：逻辑 写JSON(文本 文件路径, 通用 数据, [逻辑 格式化 = 真])
  • 说明：将通用数据序列化为 JSON 并写入文件（UTF-8）。省略格式化参数时默认真（带缩进）。
  • 参数一│文件路径: 目标 JSON 路径
  • 参数二│数据: 通用字典等可序列化数据
  • 参数三│[格式化=真]: 可选。真=缩进换行（默认）；假=紧凑单行

写配置项

  • 签名：逻辑 写配置项(文本 文件路径, 文本 节名, 文本 键名, 文本 值)
  • 说明：向 INI 写入指定节、键的值；节或键不存在则创建。成功返回真。
  • 参数一│文件路径: INI 路径；文件可不存在，通常会自动创建
  • 参数二│节名: 节名
  • 参数三│键名: 键名
  • 参数四│值: 要写入的文本

删除配置节

  • 签名：逻辑 删除配置节(文本 文件路径, 文本 节名)
  • 说明：删除 INI 中整个节及其下全部键。
  • 参数一│文件路径: INI 路径
  • 参数二│节名: 要删除的节

删除配置项

  • 签名：逻辑 删除配置项(文本 文件路径, 文本 节名, 文本 键名)
  • 说明：删除 INI 某节下的指定键；不影响同节其他键。
  • 参数一│文件路径: INI 路径
  • 参数二│节名: 节名
  • 参数三│键名: 要删除的键

取配置节列表

  • 签名：数组 取配置节列表(文本 文件路径)
  • 说明：列出 INI 文件中全部节名，返回文本数组。
  • 参数一│文件路径: INI 路径

取配置键列表

  • 签名：数组 取配置键列表(文本 文件路径, 文本 节名)
  • 说明：列出 INI 指定节下全部键名，返回文本数组。
  • 参数一│文件路径: INI 路径
  • 参数二│节名: 节名

生成JSON

  • 签名：文本 生成JSON(通用 数据, [逻辑 格式化 = 假])
  • 说明：将通用数据转为 JSON 文本。省略格式化时默认为假（紧凑）。
  • 参数一│数据: 要序列化的通用数据
  • 参数二│[格式化=假]: 可选。真=缩进；假=紧凑（默认）

解析JSON

  • 签名：通用 解析JSON(文本 JSON文本)
  • 说明：将 JSON 文本解析为通用字典。失败或非对象根时：失败返回空字典；标量根包在 “value” 下；数组根用数字键。
  • 参数一│JSON文本: JSON 字符串

读JSON

  • 签名：通用 读JSON(文本 文件路径)
  • 说明：读取 JSON 文件并解析为通用字典。文件不存在或解析失败时返回空字典。根为数组时用键 “0”,”1”,…；根为标量时包在键 “value” 下。
  • 参数一│文件路径: JSON 文件路径（按 UTF-8/自动识别读取）

读配置项

  • 签名：文本 读配置项(文本 文件路径, 文本 节名, 文本 键名, [文本 默认值=""])
  • 说明：从 INI 文件读取指定节、键的文本值；键不存在时返回默认值。底层为 Windows GetPrivateProfileString。
  • 参数一│文件路径: INI 路径（相对路径相对进程当前目录）
  • 参数二│节名: 节名，如 Settings（不含方括号）
  • 参数三│键名: 键名
  • 参数四│[默认值=”“]: 可选。不存在时返回，默认空文本

配置项是否存在

  • 签名：逻辑 配置项是否存在(文本 文件路径, 文本 节名, 文本 键名)
  • 说明：判断 INI 中指定节、键是否存在（用哨兵默认值探测，与“值为空文本”可区分）。
  • 参数一│文件路径: INI 路径
  • 参数二│节名: 节名
  • 参数三│键名: 键名

易错对照

错误 正确
未提供默认值当必有键 读前给默认或先判断
路径用相对路径丢文件 建议绝对路径

相关

INI 支持库 · 文件操作 · 注册表