📝 docs(tsl): add generated codegen reference
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,13 @@
|
||||
# Builtin - 客户端函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `assert(error)`
|
||||
|
||||
断言。若Check为假，返回出错信息
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ---------- |
|
||||
| `error` | string | 字符串类型 |
|
||||
|
||||
返回：string
|
||||
@@ -0,0 +1,47 @@
|
||||
# Builtin - 压缩和解压函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `zipCompress(zip_alias, zip_filename, file_alias, filename, path)`
|
||||
|
||||
函数事实相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------ | ---------------------------------------------------- |
|
||||
| `zip_alias` | string | ZIP 文件所在目录别名；不用别名时传空字符串 |
|
||||
| `zip_filename` | string | ZIP 文件路径；不存在时会创建 |
|
||||
| `file_alias` | string | 被压缩文件或目录的目录别名；不用别名时传空字符串 |
|
||||
| `filename` | string | 要压缩的文件或目录路径 |
|
||||
| `path` | string | 压缩后在 ZIP 内部保存的路径；空字符串表示 ZIP 根目录 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `zipExtract(zip_alias, zip_filename, output_alias, output_dir[, password])`
|
||||
|
||||
函数事实相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------ | ------------------------------------------ |
|
||||
| `zip_alias` | string | ZIP 文件所在目录别名；不用别名时传空字符串 |
|
||||
| `zip_filename` | string | ZIP 文件路径 |
|
||||
| `output_alias` | string | 解压目标目录别名；不用别名时传空字符串 |
|
||||
| `output_dir` | string | 解压目标目录 |
|
||||
| `password` | string | ZIP 密码；普通 ZIP 可省略或传空字符串 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `rarExtract(rar_alias, rar_filename, alias, path[, password])`
|
||||
|
||||
将 RAR 文件解压到指定目录。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------ | ------------------------------------------ |
|
||||
| `rar_alias` | string | RAR 文件所在目录别名；不用别名时传空字符串 |
|
||||
| `rar_filename` | string | RAR 文件名称或路径 |
|
||||
| `alias` | string | 文件解压目录别名；不用别名时传空字符串 |
|
||||
| `path` | string | 文件解压路径 |
|
||||
| `password` | string | RAR 加密密码；普通 RAR 可省略 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 未细分函数
|
||||
@@ -0,0 +1,80 @@
|
||||
# Builtin - 信息摘要及编码
|
||||
|
||||
## 函数
|
||||
|
||||
### `strToBase64(s)`
|
||||
|
||||
将字符串转换为对应类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ---------- |
|
||||
| `s` | string | 原始字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `base64ToStr(s)`
|
||||
|
||||
将输入值转换为字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ----------------- |
|
||||
| `s` | string | Base64 编码字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
## URI 编码函数
|
||||
|
||||
### `encodeUriComponent(s)`
|
||||
|
||||
按 URI component 规则编码字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------------ |
|
||||
| `s` | string | 待编码字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `decodeUriComponent(s)`
|
||||
|
||||
按 URI component 规则解码字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------------ |
|
||||
| `s` | string | 待解码字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `encodeUri(s)`
|
||||
|
||||
按 URI 规则编码字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------------ |
|
||||
| `s` | string | 待编码字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `decodeUri(s)`
|
||||
|
||||
按 URI 规则解码字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------------ |
|
||||
| `s` | string | 待解码字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
## 信息摘要函数
|
||||
|
||||
### `getMsgDigest(s, mode)`
|
||||
|
||||
计算字符串s的摘要，返回摘要的字符串
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ------ | ------------------------------------- |
|
||||
| `s` | string | 计算摘要的字符串。 |
|
||||
| `mode` | any | 指定摘要算法，摘要函数支持的算法包括: |
|
||||
|
||||
返回：string
|
||||
|
||||
## 未细分函数
|
||||
@@ -0,0 +1,96 @@
|
||||
# Builtin - 第三方交互函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `textToHtml(src)`
|
||||
|
||||
将普通文本转换为 HTML 文本；空格会转换为 ` `。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ------ | ---------------- |
|
||||
| `src` | string | 待转换的普通文本 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `textToUrl(a_src)`
|
||||
|
||||
将普通文本转换为 URL 编码文本。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ---------------- |
|
||||
| `a_src` | string | 待转换的普通文本 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `htmlToText(src)`
|
||||
|
||||
将 HTML 文本转换为普通文本；` ` 会转换为空格。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ------ | ----------------------------------------- |
|
||||
| `src` | string | 待转换的 HTML 文本；` ` 不按空格转换 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `urlToText(a_src)`
|
||||
|
||||
将 URL 编码文本转换为普通文本。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | --------------------- |
|
||||
| `a_src` | string | 待转换的 URL 编码文本 |
|
||||
|
||||
返回：string
|
||||
|
||||
## COM接口 / 天软客户端COM接口 / 属性
|
||||
|
||||
### `time()`
|
||||
|
||||
日期类型，当前环境时间系统参数，读写。
|
||||
|
||||
返回：any
|
||||
|
||||
## COM接口 / 天软客户端COM接口 / 方法
|
||||
|
||||
### `setSysParam(param_name, param_value)`
|
||||
|
||||
设置系统参数，既对本地执行有效，也对平台执行有效。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------- | ------ | ------------------------ |
|
||||
| `param_name` | string | 字符串类型，系统参数名。 |
|
||||
| `param_value` | object | 要设置的系统参数值。 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getSysParam(param_name)`
|
||||
|
||||
返回系统参数的值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ------ | ------------------------ |
|
||||
| `param_name` | string | 字符串类型，系统参数名。 |
|
||||
|
||||
返回：any
|
||||
|
||||
## COM接口 / 天软客户端COM接口 / COM类型的异常值传递处理
|
||||
|
||||
### `cverrget(v)`
|
||||
|
||||
获取NAN数据的错误号，出来的结果仅应使用低32位，也就是需要用 .& 0xFFFFFFFF，因为高字的数据是无法确定的。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ----- | ---- |
|
||||
| `v` | float | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `cverr(v)`
|
||||
|
||||
将错误号转为包含错误号的特殊的NAN数据。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ---- | ---- |
|
||||
| `v` | any | |
|
||||
|
||||
返回：float
|
||||
@@ -0,0 +1,594 @@
|
||||
# Builtin - 图形函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `encodeGraph(type, name, data, prop)`
|
||||
|
||||
编码图形对象。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ------ | -------- |
|
||||
| `type` | any | 图形类型 |
|
||||
| `name` | string | 图形名称 |
|
||||
| `data` | array | 图形数据 |
|
||||
| `prop` | array | 图形选项 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `graphGroup(arg1, arg2, arg3, arg4)`
|
||||
|
||||
作图函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
| `arg2` | any | |
|
||||
| `arg3` | any | |
|
||||
| `arg4` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
## 图形字段函数
|
||||
|
||||
### `gfColor()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfFill()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfFlag()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfZero()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfMaxValue()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfMinValue()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfLtp()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfTitleCaption()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfLeftTitleCaption()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfCoordinate()`
|
||||
|
||||
图形字段函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfValue()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfClose()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfOpen()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfHigh()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfLow()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfTowerLow()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfTowerHigh()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfTowerMid()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfVol()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfAmount()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfTime()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gfRateFlag()`
|
||||
|
||||
返回图形字段常量。
|
||||
|
||||
返回：any
|
||||
|
||||
## 图形填充设置函数
|
||||
|
||||
### `flSolid()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flClear()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flHorizontal()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flVertical()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flFDiagonal()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flBDiagonal()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flCross()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `flDiagCross()`
|
||||
|
||||
图形填充设置函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
## 图形类型函数
|
||||
|
||||
### `gtLine()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtKLine()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtTower()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtAmerican()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtBar()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtSingleBar()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `gtCircle()`
|
||||
|
||||
返回图形类型常量。
|
||||
|
||||
返回：any
|
||||
|
||||
## 图形标示函数
|
||||
|
||||
### `fgNone()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgUp()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgDown()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgLeft()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgRight()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgLeftUp()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgLeftDown()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgRightUp()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `fgRightDown()`
|
||||
|
||||
返回图形标示常量。
|
||||
|
||||
返回：any
|
||||
|
||||
## 颜色函数
|
||||
|
||||
### `clBlack()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clMaroon()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clGreen()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clOlive()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clNavy()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clPurple()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clTeal()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clGray()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clSilver()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clRed()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clLime()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clYellow()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clBlue()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clFuchsia()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clAqua()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clLtGray()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clDkGray()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clWhite()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clMoneyGreen()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clSkyBlue()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clCream()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
### `clMedGray()`
|
||||
|
||||
返回颜色常量。
|
||||
|
||||
返回：any
|
||||
|
||||
## 颜色变换函数
|
||||
|
||||
### `getCValue(color)`
|
||||
|
||||
从颜色值中取 C 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getMValue(color)`
|
||||
|
||||
从颜色值中取 M 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getYValue(color)`
|
||||
|
||||
从颜色值中取 Y 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getKValue(color)`
|
||||
|
||||
从颜色值中取 K 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `cmyk(c, m, y, k)`
|
||||
|
||||
按 C、M、Y、K 分量生成颜色值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ---- | ------ |
|
||||
| `c` | any | C 分量 |
|
||||
| `m` | any | M 分量 |
|
||||
| `y` | any | Y 分量 |
|
||||
| `k` | any | K 分量 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `rgb(r, g, b)`
|
||||
|
||||
按 R、G、B 分量生成颜色值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ---- | ------ |
|
||||
| `r` | any | R 分量 |
|
||||
| `g` | any | G 分量 |
|
||||
| `b` | any | B 分量 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `rgbbgr(color)`
|
||||
|
||||
转换 RGB/BGR 颜色值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `paletteRgb(r, g, b)`
|
||||
|
||||
按 R、G、B 分量生成调色板颜色值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ---- | ------ |
|
||||
| `r` | any | R 分量 |
|
||||
| `g` | any | G 分量 |
|
||||
| `b` | any | B 分量 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `paletteIndex(index)`
|
||||
|
||||
按调色板索引生成颜色值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ---------- |
|
||||
| `index` | any | 调色板索引 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getRValue(color)`
|
||||
|
||||
从颜色值中取 R 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getGValue(color)`
|
||||
|
||||
从颜色值中取 G 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getBValue(color)`
|
||||
|
||||
从颜色值中取 B 分量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `color` | any | 颜色值 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 作图函数
|
||||
|
||||
### `graph(type, graph_name, data, prop_n, prop_n_value)`
|
||||
|
||||
用于生成单个图形。单个图形的含义是一条折线、K线或成交量柱壮图。函数的具体的功能是：用指定的数据Data生成一个类型为Type的图形，并且用后面指定的属性参数PropN和PropNValue为图形指定修饰属性。注意，如果横坐标要显示出数据，需要把横坐标设置列名为'time' 先得到一个用于作图的二维数组GData，然后用graph函数作图，参数gtLine()表示要做折线，”MA5”是图线的名称，Gdata是作图数据，gfColor()和clBlue()是一对属性值，gfColor()指明是颜色属性，那么对应的值就是clBlue()蓝色。 在Gdata中并没有gfValue字段以及其他标准属性字段，因此将第一个数据字段'MA5'作为gfValue来作图。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | any | 整数，图形类型。为了便于使用理解，提供相应的图形类型函数，函数见图形类型函数； |
|
||||
| `graph_name` | string | 字符串，函数图线名称。 |
|
||||
| `data` | array | 二维数组，用来作图的数据。往往是由Nday2函数得到，其系统默认的数据字段名见图形字段函数。如gftime、gfclose、gfopen、gfhigh、gflow、gfvol、gfAmount。 |
|
||||
| `prop_n` | string | 指出是对哪个属性做修饰，必须和PropNValue配对出现的参数。PropN的系统默认数据字段见图形字段函数:在某种图形类别下，如果没有指定系统默认的数据字段的时候，系统会使用第一个存在的数据字段当成默认的来显示。如果存在多个系统默认的数据字段，则系统根据如下优先级别处理:例如，对于gtLine图形，由Nday函数或其他方式得到了一个二维数组GDATA，首先选择用GDATA中gfValue字段下的值作图，如果二维数组中没有gfValue字段，则选择gfClose字段下的值做图，依次类推 |
|
||||
| `prop_n_value` | any | 给出了这个属性的值。属性的定义也可以用一个一维的以字符串作下标的数组完成，如果是一维数组，则下标就是PropName，对应的值就是PropValue。Nday函数也可以指定属性，这里指定的属性与Nday指定的属性区别是Nday函数可以指定每个点的属性，这里指定的属性是整个图形的属性，每个点都相同，可以较少的占用系统资源。 |
|
||||
|
||||
返回：array
|
||||
|
||||
## 未细分函数
|
||||
@@ -0,0 +1,19 @@
|
||||
# Builtin
|
||||
|
||||
本目录为本地 TSL 内置函数。
|
||||
|
||||
函数数：1424
|
||||
|
||||
| 分类 | 文件 | 函数数 |
|
||||
| -------------- | ----------------------------------------- | -----: |
|
||||
| 基础函数 | [基础函数](basic.md) | 834 |
|
||||
| 客户端函数 | [客户端函数](client.md) | 2 |
|
||||
| 压缩和解压函数 | [压缩和解压函数](compression.md) | 5 |
|
||||
| 信息摘要及编码 | [信息摘要及编码](digest_encoding.md) | 12 |
|
||||
| 第三方交互函数 | [第三方交互函数](external_interaction.md) | 9 |
|
||||
| 图形函数 | [图形函数](graphics.md) | 86 |
|
||||
| 数学函数 | [数学函数](math.md) | 232 |
|
||||
| 其他函数 | [其他函数](other.md) | 25 |
|
||||
| 平台函数 | [平台函数](platform.md) | 9 |
|
||||
| 资源访问函数 | [资源访问函数](resource_access.md) | 143 |
|
||||
| 系统相关函数 | [系统相关函数](system.md) | 67 |
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,58 @@
|
||||
# Builtin - 平台函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `userName()`
|
||||
|
||||
获取当前用户名。
|
||||
|
||||
返回：string
|
||||
|
||||
### `functionType()`
|
||||
|
||||
取得当前运行函数的类型。
|
||||
|
||||
返回：any
|
||||
|
||||
### `functionName()`
|
||||
|
||||
取得当前运行函数的名称。
|
||||
|
||||
返回：string
|
||||
|
||||
### `functionVer(function_type, name)`
|
||||
|
||||
返回指定函数的版本号；函数版本号是函数保存在 SERVER 的版本标识，可用于判断函数是否被修改过。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------------- | ------ | -------- |
|
||||
| `function_type` | any | 函数类型 |
|
||||
| `name` | string | 函数名称 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 平台执行信息
|
||||
|
||||
### `userConfig(section, ret_type)`
|
||||
|
||||
返回用户的配置信息，Section为配置名，RetType用于指定返回的类型，0为字符串，1为数字，2为日期类型。注：此函数为特殊用途。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------- | ------ | ---------------- |
|
||||
| `section` | string | 字符串，配置名。 |
|
||||
| `ret_type` | any | 整数，返回类型。 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `sudo(uid, exp)`
|
||||
|
||||
以UID指定的用户执行EXP表达式，该EXP为隐式表达式，例如SUDO(“system”,DoSomeThing())，如用户需要用显式的表达式，采用SUDO(UID,Eval(Exp))即可。SUDO和User不一样，SUDO需要有权限，而且SUDO是完全以指定用户来执行，访问的数据资源等均以指定的UID来运行。与SetUID不一样的地方是SUDO执行完EXP后用户ID便恢复成原始的ID。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ------ | ---------------- |
|
||||
| `uid` | string | 字符串，用户名。 |
|
||||
| `exp` | any | 表达式。 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 未细分函数
|
||||
@@ -0,0 +1,702 @@
|
||||
# Builtin - 资源访问函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `sqlErrorMsg()`
|
||||
|
||||
获取最近一次 SQL 错误信息。
|
||||
|
||||
返回：string
|
||||
|
||||
### `sqlCloseConn()`
|
||||
|
||||
关闭 SQL 连接。
|
||||
|
||||
返回：any
|
||||
|
||||
## 文件访问函数
|
||||
|
||||
### `fileAttrToStr(attr)`
|
||||
|
||||
将输入值转换为字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `attr` | any | |
|
||||
|
||||
返回：string
|
||||
|
||||
### `fileModeToStr(attr)`
|
||||
|
||||
将输入值转换为字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `attr` | any | |
|
||||
|
||||
返回：string
|
||||
|
||||
### `strToFileAttr(str)`
|
||||
|
||||
将字符串转换为对应类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ------ | ---- |
|
||||
| `str` | string | |
|
||||
|
||||
返回：string
|
||||
|
||||
### `strToFileMode(str)`
|
||||
|
||||
将字符串转换为对应类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ------ | ---- |
|
||||
| `str` | string | |
|
||||
|
||||
返回：string
|
||||
|
||||
## 导入导出类型函数
|
||||
|
||||
### `ftCsv()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftXls()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftXls2()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftXls3()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftStream()`
|
||||
|
||||
文件访问函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftString()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftXml()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `ftdbf()`
|
||||
|
||||
导入导出类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
## 文件读写类型函数
|
||||
|
||||
### `rwByte()`
|
||||
|
||||
文件访问函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwInt()`
|
||||
|
||||
文件读写类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwReal()`
|
||||
|
||||
文件读写类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwStr()`
|
||||
|
||||
文件读写类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwObj()`
|
||||
|
||||
文件读写类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwRaw()`
|
||||
|
||||
文件访问函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `rwBinary()`
|
||||
|
||||
文件读写类型函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
## 网络访问以及相关函数
|
||||
|
||||
### `getUrl(src_url, parse_url)`
|
||||
|
||||
网络访问以及相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ---- |
|
||||
| `src_url` | string | |
|
||||
| `parse_url` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `createHttpSession()`
|
||||
|
||||
网络访问以及相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
## 进程相关函数
|
||||
|
||||
### `sysputenv(env_value)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ---- |
|
||||
| `env_value` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysParamStr(i)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ---- | ---- |
|
||||
| `i` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysErrorMessage(arg1)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysgetenv(name)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ------ | ---- |
|
||||
| `name` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysWaitForMultipleObjects(objects, b_wait_all, wait_ms)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ----- | ---- |
|
||||
| `objects` | array | |
|
||||
| `b_wait_all` | any | |
|
||||
| `wait_ms` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysCreateMutex(mutex_name)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ------ | ---- |
|
||||
| `mutex_name` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysReleaseMutex(ret)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ---- | ---- |
|
||||
| `ret` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysProcessId()`
|
||||
|
||||
获取当前进程 ID（PID）。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysParamcount()`
|
||||
|
||||
获取命令行传入参数的个数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysThreadId()`
|
||||
|
||||
获取当前线程 ID。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sleep(arg1)`
|
||||
|
||||
让当前线程休眠指定毫秒数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
|
||||
返回：void
|
||||
|
||||
### `sysWaitForSingleObject(hand1, arg2)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ---- |
|
||||
| `hand1` | any | |
|
||||
| `arg2` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetenvs()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysexecGetenvs()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysexecDeletepipe(hand)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `hand` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysexecNewpipe(arg1)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `dbglocalrunning()`
|
||||
|
||||
返回本地解释器正在运行的任务列表与调用栈信息。
|
||||
|
||||
返回：array
|
||||
|
||||
### `dbglocalcancel(task_id)`
|
||||
|
||||
根据任务 ID 终止本地运行中的任务。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | ---- |
|
||||
| `task_id` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysThreadSelf()`
|
||||
|
||||
获取当前线程 ID（Linux 下为 pthread_t）。
|
||||
|
||||
返回：any
|
||||
|
||||
### `syslinuxkrnlclosemutex(name, isprivate)`
|
||||
|
||||
关闭并清理指定互斥量（Linux），用于移除互斥相关的系统信号量与临时文件。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ---- |
|
||||
| `name` | string | |
|
||||
| `isprivate` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysSetThreadPriority(arg1[, arg2])`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
| `arg2` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetThreadPriority(pri[, arg2])`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `pri` | any | |
|
||||
| `arg2` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetProcessList()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetProcessListw()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetThreadName([arg1])`
|
||||
|
||||
获取线程名称。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
|
||||
返回：string
|
||||
|
||||
### `sysGetThreads()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysPPid()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetSubProcesses()`
|
||||
|
||||
进行字符串提取或替换处理。
|
||||
|
||||
返回：string
|
||||
|
||||
### `sysPidOfTid(tid)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----- | ---- | ---- |
|
||||
| `tid` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysPidOfHandle(handle)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ---- | ---- |
|
||||
| `handle` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysHandleOfPid(arg1)`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | ---- |
|
||||
| `arg1` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysGetLastError()`
|
||||
|
||||
获取最近一次系统错误码。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysCmdLine()`
|
||||
|
||||
获取当前进程命令行。
|
||||
|
||||
返回：string
|
||||
|
||||
### `sysClientInfo()`
|
||||
|
||||
获取客户端信息。
|
||||
|
||||
返回：any
|
||||
|
||||
## 本地资源相关函数
|
||||
|
||||
### `sysExecName()`
|
||||
|
||||
获取当前执行程序的完整路径。
|
||||
|
||||
返回：string
|
||||
|
||||
### `pluginPath()`
|
||||
|
||||
获取插件目录路径。
|
||||
|
||||
返回：string
|
||||
|
||||
### `getlogicdrive()`
|
||||
|
||||
本地资源相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `createlink(link_name, target_name, hard)`
|
||||
|
||||
本地资源相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------- | ------ | ---- |
|
||||
| `link_name` | string | |
|
||||
| `target_name` | string | |
|
||||
| `hard` | any | |
|
||||
|
||||
返回：any
|
||||
|
||||
### `realpath(name)`
|
||||
|
||||
本地资源相关函数相关函数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ------ | ---- |
|
||||
| `name` | string | |
|
||||
|
||||
返回：any
|
||||
|
||||
## 数据库访问函数
|
||||
|
||||
### `sqlCloseConn(db_alias)`
|
||||
|
||||
主动关闭指定别名的数据库链接或者关闭所有数据库链接。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------- | ------ | ---------------------- |
|
||||
| `db_alias` | string | 数据库别名，可选参数。 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 文件访问函数
|
||||
|
||||
### `exportFile(type, alias, file_name, data, include_header, include_index)`
|
||||
|
||||
将数据导出为文件。支持将INF以及NAN导出到Excel，INF对应为EXCEL的DIV0，NAN对应为NA
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------------- | ------ | --------------------------------------------------------------------------------------------- |
|
||||
| `type` | any | 整数类型，参考FAQ：导入导出类型函数。 |
|
||||
| `alias` | string | 字符串类型，参考目录别名；如果没有配置用户别名，可直接在FileName中写上路径，该字段赋值为""。 |
|
||||
| `file_name` | string | 字符串类型。文件名称。如果没有给别名，可以在FileName中把路径写上，比如"D:\\test\\test1.xls"。 |
|
||||
| `data` | array | 输出的数据内容。 |
|
||||
| `include_header` | bool | object |
|
||||
| `include_index` | bool | object |
|
||||
|
||||
返回：string|bool
|
||||
|
||||
### `importFile(type, alias, file_name, data, include_header, include_index, force_single, sheet_name)`
|
||||
|
||||
从文件中导入数据。对EXCEL文件自动识别.xls或者.xlsx的文件格式，支持将INF以及NAN导入
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | any | 整数类型。参考FAQ：导入导出类型函数 |
|
||||
| `alias` | string | 字符串类型。参考目录别名。 |
|
||||
| `file_name` | string | 字符串类型。文件名称。 |
|
||||
| `data` | array | 输出参数，存贮导入的数据。当导入成功的时候，数据将存放在Data中，否则将存贮返回的错误信息。 |
|
||||
| `include_header` | bool | object |
|
||||
| `include_index` | bool | object |
|
||||
| `force_single` | bool | object |
|
||||
| `sheet_name` | string | 字符串或者整数。在导入XLS文件的时候，可以指定从哪个SHEET里导入数据，可以以第几个SHEET或者SHEET名来设置SHEET参数。SHEET的序列从1开始。 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `parseHtml(html, parsed, attr_name_is_index)`
|
||||
|
||||
将指定的Html字符串解析成为类似于DOM格式的结构。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------------- | ------ | ------------------------------ |
|
||||
| `html` | string | 字符串类型，所需解析的HTML串。 |
|
||||
| `parsed` | array | 存放返回的类DOM结构。 |
|
||||
| `attr_name_is_index` | bool | object |
|
||||
|
||||
返回：string
|
||||
|
||||
## 进程相关函数
|
||||
|
||||
### `sysTerminate(ret_code, handle)`
|
||||
|
||||
终止进程。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------- | ------ | ------------------------------------------ |
|
||||
| `ret_code` | string | 整数，终止进程返回的代码。 |
|
||||
| `handle` | any | 整数，终止进程的句柄。缺省为终止自身进程。 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysCloseHandle(handle)`
|
||||
|
||||
关闭一个句柄，如互斥锁，文件句柄等。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ---- | -------------- |
|
||||
| `handle` | any | 整数，句柄编号 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `dbglocalrunning(return_value)`
|
||||
|
||||
获得当前所有的任务列表以及堆栈信息，主要用于web等检查在运行中的任务。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ----- | --------------------------------------------------------------------- |
|
||||
| `return_value` | array | 获得当前所有的任务列表以及堆栈信息，主要用于web等检查在运行中的任务。 |
|
||||
|
||||
返回：array
|
||||
|
||||
### `sysGetProcessList(return_value)`
|
||||
|
||||
获取当前进程列表信息
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ----- | -------------------------------------------------------------------------- |
|
||||
| `return_value` | array | 获取成功，返回包含进程信息的数组；否则，返回0。 返回结果中各字段含义如下： |
|
||||
|
||||
返回：array
|
||||
|
||||
### `sysGetProcessListw(return_value)`
|
||||
|
||||
获取当前进程列表信息，信息中字符串为宽字节字符串
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ----- | -------------------------------------------------------------------------- |
|
||||
| `return_value` | array | 获取成功，返回包含进程信息的数组；否则，返回0。 返回结果中各字段含义如下： |
|
||||
|
||||
返回：array
|
||||
|
||||
## 进程相关函数 / 获取COM进程
|
||||
|
||||
### `sysGetWndOfCaption(cap, is_contain_string)`
|
||||
|
||||
获得所有标题窗口串包含或者等于指定串的所有窗口句柄。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------------- | ------ | ---------------------------------------------- |
|
||||
| `cap` | string | 字符串，窗口的标题。 |
|
||||
| `is_contain_string` | any | 布尔类型，是否包含，可选参数参数，默认是包含。 |
|
||||
|
||||
返回：array
|
||||
|
||||
### `sysGetPidtidOfWnd(wnd, thread_id)`
|
||||
|
||||
获得窗口句柄的进程ID, 通过ThreadId可输出线程id
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ------------------------------------------------ |
|
||||
| `wnd` | any | 整型，窗口句柄。 |
|
||||
| `thread_id` | string | 输出值，整型，线程号，给定该参数可以获取线程ID。 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 未细分函数
|
||||
|
||||
### `iniWriteBool()`
|
||||
|
||||
INI文件处理函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `iniWriteDate()`
|
||||
|
||||
日期时间处理函数。
|
||||
|
||||
返回：datetime
|
||||
|
||||
### `iniWriteDateTime()`
|
||||
|
||||
日期时间处理函数。
|
||||
|
||||
返回：datetime
|
||||
|
||||
### `iniWriteFloat()`
|
||||
|
||||
INI文件处理函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `iniWriteInteger()`
|
||||
|
||||
INI文件处理函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `iniWriteTime()`
|
||||
|
||||
日期时间处理函数。
|
||||
|
||||
返回：datetime
|
||||
|
||||
### `iniWriteString()`
|
||||
|
||||
INI文件处理函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `iniDeleteKey()`
|
||||
|
||||
INI文件处理函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysTerminate()`
|
||||
|
||||
进程相关函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `sysSetThreadName(arg1[, arg2])`
|
||||
|
||||
设置线程名称（Linux 仅支持当前线程）。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ------ | ---- |
|
||||
| `arg1` | string | |
|
||||
| `arg2` | any | |
|
||||
|
||||
返回：string
|
||||
@@ -0,0 +1,540 @@
|
||||
# Builtin - 系统相关函数
|
||||
|
||||
## 函数
|
||||
|
||||
### `dataType(value, mode)`
|
||||
|
||||
返回数据类型编号，支持数组遍历模式。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：array
|
||||
|
||||
### `ifInt(value, mode)`
|
||||
|
||||
判断是否为 32 位整数类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------------------------------------------------- |
|
||||
| `value` | array | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifInt64(value, mode)`
|
||||
|
||||
判断是否为 64 位整数类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifReal(value, mode)`
|
||||
|
||||
判断是否为 实数类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------------------------------------------------- |
|
||||
| `value` | array | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifNumber(value, mode)`
|
||||
|
||||
判断是否为 数字（整数或实数）类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------------------------------------------------- |
|
||||
| `value` | array | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifString(value, mode)`
|
||||
|
||||
判断是否为 字符串类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------------------------------------------------- |
|
||||
| `value` | array | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifArray(value, mode)`
|
||||
|
||||
判断是否为 数组类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifNil(value, mode)`
|
||||
|
||||
判断是否为 Nil类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifNone(value[, tag])`
|
||||
|
||||
判断对象 `operator[1]` 多级下标写入时传入的 None 标记值。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------ |
|
||||
| `value` | void | `operator[1]` 中间层或回滚层传入的 None 值 |
|
||||
| `tag` | any | None 标记值；中间层第一层为 `0`，回滚标记为 `-1` |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifExp(value, mode)`
|
||||
|
||||
判断是否为 表达式类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifGraph(value)`
|
||||
|
||||
判断是否为 图形类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------- |
|
||||
| `value` | any | 输入数据 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifGraphGroup(value)`
|
||||
|
||||
判断是否为 图形组类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------- |
|
||||
| `value` | any | 输入数据 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifBinary(value, mode)`
|
||||
|
||||
判断是否为 二进制/Buffer类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------------------------------------------------------- |
|
||||
| `value` | any | 输入数据 |
|
||||
| `mode` | any | 遍历模式（可选；-1 对第一维逐项判断；1 对每个元素判断） |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifMatrix(value)`
|
||||
|
||||
判断是否为 Matrix类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------- |
|
||||
| `value` | any | 输入数据 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifFmarray(value)`
|
||||
|
||||
判断是否为 FMArray 类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------- |
|
||||
| `value` | any | 输入数据 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifObj(value)`
|
||||
|
||||
判断是否为对象类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------- |
|
||||
| `value` | any | 输入数据 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `createBinary(size)`
|
||||
|
||||
创建 Binary 缓冲区。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | -------- |
|
||||
| `size` | any | 字节长度 |
|
||||
|
||||
返回：binary
|
||||
|
||||
## 复制函数
|
||||
|
||||
### `dupValue(value)`
|
||||
|
||||
复制值，避免被调用函数修改原变量。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ------ |
|
||||
| `value` | any | 输入值 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 条件选择函数
|
||||
|
||||
### `ifThen(condition, true_value, false_value)`
|
||||
|
||||
条件成立返回 true_value，否则返回 false_value。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------- | ---- | ------------------ |
|
||||
| `condition` | any | 判断条件 |
|
||||
| `true_value` | any | 条件成立时返回值 |
|
||||
| `false_value` | any | 条件不成立时返回值 |
|
||||
|
||||
返回：bool
|
||||
|
||||
## 数据类型转换函数
|
||||
|
||||
### `integer(value)`
|
||||
|
||||
将数值转换为整数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | -------- |
|
||||
| `value` | float | 输入数值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `int64(value)`
|
||||
|
||||
将数值转换为 64 位整数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | -------- |
|
||||
| `value` | float | 输入数值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `real(value)`
|
||||
|
||||
将数值转换为实数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----- | -------- |
|
||||
| `value` | float | 输入数值 |
|
||||
|
||||
返回：float
|
||||
|
||||
### `wideString(value)`
|
||||
|
||||
将数据转换为 Unicode 字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | -------- |
|
||||
| `value` | string | 输入数据 |
|
||||
|
||||
返回：string
|
||||
|
||||
### `binary(value)`
|
||||
|
||||
将数据转换为二进制流。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | -------- |
|
||||
| `value` | string | 输入数据 |
|
||||
|
||||
返回：binary
|
||||
|
||||
### `setPrecision(value, digits)`
|
||||
|
||||
设置数值的小数精度。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | -------- |
|
||||
| `value` | float | 输入数值 |
|
||||
| `digits` | any | 小数位数 |
|
||||
|
||||
返回：float
|
||||
|
||||
### `toStm(value, mode, precision[, arg4])`
|
||||
|
||||
将数据序列化为 STM 二进制流。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ----- | ------------------ |
|
||||
| `value` | array | 输入数据 |
|
||||
| `mode` | any | 序列化模式（可选） |
|
||||
| `precision` | any | 小数位数（可选） |
|
||||
| `arg4` | any | |
|
||||
|
||||
返回：binary
|
||||
|
||||
### `toStn(value, digits)`
|
||||
|
||||
将数值格式化为 STN 字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | ---------------- |
|
||||
| `value` | float | 输入数值 |
|
||||
| `digits` | any | 小数位数（可选） |
|
||||
|
||||
返回：string
|
||||
|
||||
### `exportCsv(data, out_text, include_index, include_header)`
|
||||
|
||||
将数组导出为 CSV 格式字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------------- | ------ | ------------------------- |
|
||||
| `data` | array | 数组数据 |
|
||||
| `out_text` | string | 输出字符串（引用返回） |
|
||||
| `include_index` | any | 是否包含下标（可选，1/0） |
|
||||
| `include_header` | any | 是否包含表头（可选，1/0） |
|
||||
|
||||
返回：array
|
||||
|
||||
### `stn(v)`
|
||||
|
||||
解析 STN 数值字符串。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ---------- |
|
||||
| `v` | string | STN 字符串 |
|
||||
|
||||
返回：string
|
||||
|
||||
## 全局缓存函数
|
||||
|
||||
### `ifCache(value)`
|
||||
|
||||
判断值是否仍是全局缓存引用。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | ---------- |
|
||||
| `value` | any | 待判断的值 |
|
||||
|
||||
返回：bool
|
||||
|
||||
## 随机函数
|
||||
|
||||
### `randomize()`
|
||||
|
||||
随机函数相关函数。
|
||||
|
||||
返回：any
|
||||
|
||||
### `random([value])`
|
||||
|
||||
生成随机数。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------------- |
|
||||
| `value` | any | value 为上限（可选） |
|
||||
|
||||
返回：float
|
||||
|
||||
### `randomFrom(avalues)`
|
||||
|
||||
从数组中随机取一个元素。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ----- | -------- |
|
||||
| `avalues` | array | 候选数组 |
|
||||
|
||||
返回：array
|
||||
|
||||
## 表达式相关函数
|
||||
|
||||
### `tslfilename()`
|
||||
|
||||
获取正在执行的 `.tsl` 主脚本完整路径。
|
||||
|
||||
返回：string
|
||||
|
||||
### `sysgettsllibpath()`
|
||||
|
||||
获取当前函数库查找路径。
|
||||
|
||||
返回：string
|
||||
|
||||
## 错误与断言函数
|
||||
|
||||
### `assert(check, error_message)`
|
||||
|
||||
断言 `check` 是否为真值；为真时返回 `0` 并继续执行，为假时抛出 `error_message` 指定的运行时错误。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------------- | ------ | --------------------------------------- |
|
||||
| `check` | any | 按 TSL 真值规则判断；真值通过，假值失败 |
|
||||
| `error_message` | string | 断言失败时抛出的错误信息 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 性能优化相关函数
|
||||
|
||||
### `setProfiler(flags)`
|
||||
|
||||
设置性能分析开关与统计范围。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------- |
|
||||
| `flags` | any | 统计选项位掩码 |
|
||||
|
||||
返回：void
|
||||
|
||||
### `getProfilerInfo(mode)`
|
||||
|
||||
获取性能分析信息。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ---- | --------------------------- |
|
||||
| `mode` | any | 可选；传 1 仅返回信息不弹窗 |
|
||||
|
||||
返回：any
|
||||
|
||||
## 数据类型函数
|
||||
|
||||
### `ifGraph(value, n)`
|
||||
|
||||
判断value是否是一个图形类型。可通过可选参数N对数组中的行或元素进行判断。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------------------------- |
|
||||
| `value` | any | 任意类型数据 |
|
||||
| `n` | any | 可选参数，整数。具体参考返回说明 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifGraphgroup(value, n)`
|
||||
|
||||
判断value是否是一个图形组合类型。可通过可选参数N对数组中的行或元素进行判断。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------------------------- |
|
||||
| `value` | any | 任意类型数据 |
|
||||
| `n` | any | 可选参数，整数。具体参考返回说明 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifMatrix(value, n)`
|
||||
|
||||
判断value是否是一个Matrix类型。可通过可选参数N对数组中的行或元素进行判断。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------------------------- |
|
||||
| `value` | any | 任意类型数据 |
|
||||
| `n` | any | 可选参数，整数。具体参考返回说明 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `ifObj(value, n)`
|
||||
|
||||
判断value是否是一个ComObj对象或者一个TSL的对象类型。可通过可选参数N对数组中的行或元素进行判断。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ---- | -------------------------------- |
|
||||
| `value` | any | 任意类型数据 |
|
||||
| `n` | any | 可选参数，整数。具体参考返回说明 |
|
||||
|
||||
返回：bool
|
||||
|
||||
### `getOleObject(class_name, method, obj)`
|
||||
|
||||
获取一个ComObj对象类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `class_name` | string | 字符串，对象的类名。 |
|
||||
| `method` | any | 整数，产生方法的方法，1:获取一个存在的对象，2:新建一个对象，其他值:如果存在则获取一个存在对象，不存在则创建。 |
|
||||
| `obj` | object | 保存返回的对象。 |
|
||||
|
||||
返回：bool
|
||||
|
||||
## 数据类型转换函数
|
||||
|
||||
### `importCsv(csv_str, data, include_index, include_header, single_arr)`
|
||||
|
||||
将指定csv格式字符串csvStr转换为数组，并存储在Data参数中。 支持范围：新一代TSL支持。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------------- | ------ | ------------------------------------ |
|
||||
| `csv_str` | string | 字符串类型，csv格式字符串。 |
|
||||
| `data` | array | 数组类型，转换成功的数组（输出值）。 |
|
||||
| `include_index` | bool | object |
|
||||
| `include_header` | bool | object |
|
||||
| `single_arr` | bool | object |
|
||||
|
||||
返回：array
|
||||
|
||||
## 表达式相关函数
|
||||
|
||||
### `arrayToFm(value, sample_value)`
|
||||
|
||||
将数组转换为 FMArray，并按样例值确定单元格类型。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ----- | ----------------------------------------------------------- |
|
||||
| `value` | array | 输入数组 |
|
||||
| `sample_value` | float | 单元格类型样例；如 `0` 生成整型单元格，`0.0` 生成浮点单元格 |
|
||||
|
||||
返回：array
|
||||
|
||||
### `importCsv(csv_text, out_data, has_header)`
|
||||
|
||||
将 CSV 字符串解析为数组。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ------ | ------------------------- |
|
||||
| `csv_text` | string | CSV 字符串 |
|
||||
| `out_data` | array | 输出数组（引用返回） |
|
||||
| `has_header` | any | 是否包含表头（可选，1/0） |
|
||||
|
||||
返回：array
|
||||
|
||||
### `stm(value)`
|
||||
|
||||
解析 STM 序列化数据。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ------ |
|
||||
| `value` | string | binary |
|
||||
|
||||
返回：any
|
||||
|
||||
### `setGlobalCache(name, value)`
|
||||
|
||||
写入全局缓存。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ------------ |
|
||||
| `name` | string | 缓存键 |
|
||||
| `value` | any | 写入缓存的值 |
|
||||
|
||||
返回：any
|
||||
|
||||
### `getGlobalCache(name, out_value)`
|
||||
|
||||
按键读取全局缓存。
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | -------------------- |
|
||||
| `name` | string | 缓存键 |
|
||||
| `out_value` | any | 输出变量，接收缓存值 |
|
||||
|
||||
返回：any
|
||||
Reference in New Issue
Block a user