getIniFile()

语法

getIniFile( <filename>, [flags] )

类别

Remote

描述

打开一个远程 INI 配置文件。

参数

参数名参数类型默认值描述是否必填
filenamestring—-文件路径是
flagsintSDB_INIFILE_FLAGS_DEFAULT解析 ini 配置的选项否

flags 参数的可选值如下表：

可选值描述
SDB_INIFILE_NOTCASE不区分大小写
SDB_INIFILE_SEMICOLON支持分号( ; )注释符
SDB_INIFILE_HASHMARK支持井号( # )注释符
SDB_INIFILE_ESCAPE支持转义字符，如：\n
SDB_INIFILE_DOUBLE_QUOMARK支持带双引号( " )的值
SDB_INIFILE_SINGLE_QUOMARK支持带单引号( ' )的值
SDB_INIFILE_EQUALSIGN支持等号( = )的键值分隔符
SDB_INIFILE_COLON支持冒号( : )的键值分隔符
SDB_INIFILE_UNICODE支持 Unicode 编码
SDB_INIFILE_STRICTMODE开启严格模式，不允许重复的段名和键名
SDB_INIFILE_FLAGS_DEFAULT默认的 flags，等同于 SDB_INIFILE_SEMICOLON | SDB_INIFILE_EQUALSIGN | SDB_INIFILE_STRICTMODE

Note：以上标志位可以使用或运算符 "|"，按位运算组合使用。

返回值

执行成功，返回一个新的远程 IniFile 对象。

执行失败，抛异常。

错误

如果出错则抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。关于错误处理可以参考常见错误处理指南。

常见错误可参考错误码。

示例

  • 创建一个远程连接对象
  1. > var remoteObj = new Remote( "sdbserver1", 11790 )
  • 创建一个远程 IniFile 对象。
  1. > var ini = remoteObj.getFile( "/opt/sequoiadb/file.ini", SDB_INIFILE_FLAGS_DEFAULT )