📝 docs(tsl): add generated codegen reference
This commit is contained in:
@@ -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
|
||||
Reference in New Issue
Block a user