csh/playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 docs(tsl): complete and lint codegen reference

Browse Source
This commit is contained in:
csh
2026-07-07 16:46:51 +08:00
parent 16e0992dd2
commit bbf6977f57
232 changed files with 39191 additions and 29763 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tsl/codegen/builtin/resource/process.md
+87 -87
View File
@@ -4,8 +4,8 @@
暂停执行。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| -------------- | ------- | --------------------------------------------------- |
| `milliseconds` | integer | 整数，需要暂停的毫秒数。例如暂停一秒为Sleep(1000)。 |
返回：nil
@@ -23,9 +23,9 @@ echo 456;
获得命令行的指定索引的参数值。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `index` | | 整数，命令行参数的索引号。Index=0，返回值为当前天软脚本文件名称；Index>0，返回值为额外传入的命令行参数值（字符串类型） |
| 参数 | 类型 | 说明 |
| ------- | ---- | ---------------------------------------------------------------------------------------------------------------------- |
| `index` | | 整数，命令行参数的索引号。Index=0，返回值为当前天软脚本文件名称；Index>0，返回值为额外传入的命令行参数值（字符串类型） |
返回：string
@@ -49,8 +49,8 @@ end
释放一个互斥锁。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------- | ------- | ---------------- |
| `mutex` | integer | 整数，互斥锁编号 |
返回：bool
@@ -69,8 +69,8 @@ return ret1;
创建Sysexec进程的管道。参数缺省时，默认创建读写管道。创建之后会与第一次被用的进程进行绑定，当有多个Sysexec进程时，可以创建多个管道分别进行读写操作。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------ | ------- | ---------------------------------------------------------------------------------------------------- |
| `flag` | integer | 整数，可选参数，控制创建管道的读写属性。Flag转换为二进制时，第0位表示是否可读，第1位表示是否可写。即 |
返回：bool
@@ -104,9 +104,9 @@ return array(hand, t1, t2);
删除指定进程的管道。参数缺省时，删除默认管道。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `process_handle` | | 数值，可选参数，进程句柄。 |
| 参数 | 类型 | 说明 |
| ---------------- | ---- | -------------------------- |
| `process_handle` | | 数值，可选参数，进程句柄。 |
返回：bool
@@ -146,8 +146,8 @@ return false;
获得进程的子进程列表
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | -------------------------------------------------------------- |
| `pid` | integer | 整数，可选参数，进程ID。未指定时默认获取当前进程内的子进程列表 |
返回：array,tablearray
@@ -192,8 +192,8 @@ return sysGetMemoryUsage();
获取进程的内存使用状态
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | ---------------------------------------------------------- |
| `pid` | integer | 整数，可选参数，进程ID。未指定时默认获取自身的内存使用状态 |
返回：array
@@ -223,10 +223,10 @@ return sysLibCVersion();
对相应的数据进行处理，注意，该函数主要用于客户端结果处理，不提供给用户程序编辑。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------------ | ------ | ---------------- |
| `field_name` | string | 字符串，字段名称 |
| `call_back` | string | 字符串，函数名称 |
| `call_back` | string | 字符串，函数名称 |
返回：array,tablearray
@@ -234,8 +234,8 @@ return sysLibCVersion();
对相应数据进行处理。注意，该函数主要用于客户端结果处理，不提供给用户程序编辑。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----------- | ------ | ---------------- |
| `call_back` | string | 字符串，函数名称 |
返回：array,tablearray
@@ -244,8 +244,8 @@ return sysLibCVersion();
设置当前运行环境的指定环境变量的值。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----------- | ------ | --------------------------- |
| `env_value` | string | 字符串，环境变量名=变量值。 |
返回：integer
@@ -287,8 +287,8 @@ if ret=0 then return sysgetenv("OS"); // 更改成功，获取更改后的环境
返回指定代码表示的系统错误信息。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------ | ------- | -------------- |
| `code` | integer | 整数，提示代码 |
返回：string
@@ -304,8 +304,8 @@ return rdo2 sysErrorMessage(200);
获取当前运行环境下指定环境变量的值。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------ | ------ | -------------------- |
| `name` | string | 字符串，环境变量名。 |
返回：string
@@ -323,11 +323,11 @@ return sysgetenv("OS");
等待占有多个对象,例如互斥对象。支持windows和linux的进程
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `objects` | array of integer | 一维数字数组，对象句柄数组 |
| `b_wait_all` | bool | 真假，是否等待所有的对象。为真等待所有的，为假则仅需任意一个对象等待成功。 |
| `wait_ms` | integer | 整数，等待的毫秒数，-1则为永远等待。 |
| 参数 | 类型 | 说明 |
| ------------ | ---------------- | -------------------------------------------------------------------------- |
| `objects` | array of integer | 一维数字数组，对象句柄数组 |
| `b_wait_all` | bool | 真假，是否等待所有的对象。为真等待所有的，为假则仅需任意一个对象等待成功。 |
| `wait_ms` | integer | 整数，等待的毫秒数，-1则为永远等待。 |
返回：integer
@@ -356,8 +356,8 @@ test_echo.tsf: sleep(2 * 1000); // 停2秒echo 'TestEchoIN\r\n';return 1;
创建一个互斥锁。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------ |
| `mutex_name` | string | 字符串，互斥锁名称 |
返回：integer
@@ -420,9 +420,9 @@ return rdo2 sysThreadId();
等待占有一个对象,例如互斥对象。支持windows和linux的进程
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `object` | integer | 整数，对象名柄 |
| 参数 | 类型 | 说明 |
| --------- | ------- | ------------------------------------ |
| `object` | integer | 整数，对象名柄 |
| `wait_ms` | integer | 整数，等待的毫秒数，-1则为永远等待。 |
返回：integer
@@ -474,8 +474,8 @@ return sysexecGetenvs();
注销任务。该功能可以用来终止运行的WEB任务。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ---- | ------- | ----------------------------------------------------------------- |
| `id` | integer | 为dbglocalrunning中返回信息中的id字段以十六进制模式转换为64位整数 |
返回：bool
@@ -499,10 +499,10 @@ return sysThreadSelf();
支持在LINUX上手动删除掉因互斥支持产生的系统信号量以及临时目录的文件
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `name` | string | 字符串，互斥锁名称 |
| `isprivate` | bool | 是否私有 |
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `name` | string | 字符串，互斥锁名称 |
| `isprivate` | bool | 是否私有 |
返回：any
@@ -510,9 +510,9 @@ return sysThreadSelf();
设置线程优先级
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `pri` | integer | 线程优先级 |
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------------------------------------------ |
| `pri` | integer | 线程优先级 |
| `tid` | integer | 可选参数，线程ID。未指定时默认设置当前线程优先级 |
返回：integer
@@ -557,9 +557,9 @@ end;
获取线程优先级
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `pri` | integer | 变参，整数，线程优先级 |
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------------------------------------------------ |
| `pri` | integer | 变参，整数，线程优先级 |
| `tid` | integer | 整数，可选参数，线程ID。未指定时默认获取当前线程优先级 |
返回：integer
@@ -591,8 +591,8 @@ return "获取线程优先级失败！";
获取线程名称
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | ---------------------------------------------------- |
| `tid` | integer | 整数，可选参数，线程ID。未指定时默认获取当前线程名称 |
返回：string
@@ -624,8 +624,8 @@ return "获取线程名称失败！";
获取进程内的线程列表
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------------------------------------------------------ |
| `pid` | integer | 整数，可选参数，进程ID。未指定时默认获取当前进程内的线程列表 |
返回：array,tablearray
@@ -655,8 +655,8 @@ return ret;
获得进程的父进程ID
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | ---------------------------------------------------------- |
| `pid` | integer | 整数，可选参数，进程ID。未指定时默认获取当前进程的父进程ID |
返回：integer
@@ -690,8 +690,8 @@ return "获取进程的父进程ID失败！";
获取线程所属进程ID
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------ |
| `tid` | integer | 整数，线程ID |
返回：integer
@@ -713,8 +713,8 @@ return "获取线程所属进程ID失败！"
根据进程句柄获取进程ID。在Linux上，返回和进程句柄值相同的整数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| -------- | ------- | -------- |
| `handle` | integer | 进程句柄 |
返回：integer
@@ -743,20 +743,20 @@ return "根据进程句柄获取进程ID失败！"
Windows上获取进程id对应的句柄，Linux上获取指定文件ID的复制ID。得到的句柄可用函数FAQ：SysCloseHandle进行关闭。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `pid` | integer | 整数，进程ID |
| `rights` | integer | 整数，可选参数，设置进程句柄权限，Linux上无效。常见的权限设置值见下表。 |
| `inherithandle` | integer | 布尔值，可选参数，是否继承，Linux上无效 |
| 参数 | 类型 | 说明 |
| --------------- | ------- | ----------------------------------------------------------------------- |
| `pid` | integer | 整数，进程ID |
| `rights` | integer | 整数，可选参数，设置进程句柄权限，Linux上无效。常见的权限设置值见下表。 |
| `inherithandle` | integer | 布尔值，可选参数，是否继承，Linux上无效 |
常见权限值：
| 值 | 十进制值 | 访问权限 | 可操作范围 |
| --- | --- | --- | --- |
| `0x0010` | 16 | PROCESS_VM_READ | 读取进程内存内容 |
| `0x0400` | 1024 | PROCESS_QUERY_INFORMATION | 查询完整进程信息（令牌、优先级等） |
| `0x1000` | 4096 | PROCESS_QUERY_LIMITED_INFORMATION（缺省值） | 仅查询进程基础信息（PID、退出代码等） |
| `0xFFFF` | 65535 | PROCESS_ALL_ACCESS | 所有权限（包括终止、内存写入等） |
| 值 | 十进制值 | 访问权限 | 可操作范围 |
| -------- | -------- | ------------------------------------------- | ------------------------------------- |
| `0x0010` | 16 | PROCESS_VM_READ | 读取进程内存内容 |
| `0x0400` | 1024 | PROCESS_QUERY_INFORMATION | 查询完整进程信息（令牌、优先级等） |
| `0x1000` | 4096 | PROCESS_QUERY_LIMITED_INFORMATION（缺省值） | 仅查询进程基础信息（PID、退出代码等） |
| `0xFFFF` | 65535 | PROCESS_ALL_ACCESS | 所有权限（包括终止、内存写入等） |
返回：integer
@@ -776,10 +776,10 @@ Windows上获取进程id对应的句柄，Linux上获取指定文件ID的复制I
终止进程。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `ret_code` | integer | 整数，终止进程返回的代码。 |
| `handle` | integer | 整数，终止进程的句柄。缺省为终止自身进程。 |
| 参数 | 类型 | 说明 |
| ---------- | ------- | ------------------------------------------ |
| `ret_code` | integer | 整数，终止进程返回的代码。 |
| `handle` | integer | 整数，终止进程的句柄。缺省为终止自身进程。 |
返回：any
@@ -787,8 +787,8 @@ Windows上获取进程id对应的句柄，Linux上获取指定文件ID的复制I
关闭一个句柄，如互斥锁，文件句柄等。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| -------- | ------- | -------------- |
| `handle` | integer | 整数，句柄编号 |
返回：bool
@@ -863,10 +863,10 @@ return "当前进程列表信息失败！";
获得所有标题窗口串包含或者等于指定串的所有窗口句柄。
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `cap` | string | 字符串，窗口的标题。 |
| `is_contain_string` | | 布尔类型，是否包含，可选参数参数，默认是包含。 |
| 参数 | 类型 | 说明 |
| ------------------- | ------ | ---------------------------------------------- |
| `cap` | string | 字符串，窗口的标题。 |
| `is_contain_string` | | 布尔类型，是否包含，可选参数参数，默认是包含。 |
返回：array of hwnd
@@ -882,9 +882,9 @@ echo v;
获得窗口句柄的进程ID, 通过ThreadId可输出线程id
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `wnd` | hwnd | 整型，窗口句柄。 |
| 参数 | 类型 | 说明 |
| ----------- | ------- | ------------------------------------------------ |
| `wnd` | hwnd | 整型，窗口句柄。 |
| `thread_id` | integer | 输出值，整型，线程号，给定该参数可以获取线程ID。 |
返回：integer
@@ -904,10 +904,10 @@ echo v;
设置线程名称
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `name` | string | 字符串，要设置的名称 |
| `tid` | integer | 整数，可选参数，线程ID。未指定时默认设置当前线程名称 |
| 参数 | 类型 | 说明 |
| ------ | ------- | ---------------------------------------------------- |
| `name` | string | 字符串，要设置的名称 |
| `tid` | integer | 整数，可选参数，线程ID。未指定时默认设置当前线程名称 |
返回：integer