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

✨ feat(tsl-api-reference): update API catalog and data dictionary

Browse Source
This commit is contained in:
csh
2026-08-11 18:10:24 +08:00
parent 34a3a5dec1
commit 7bd965de89
1231 changed files with 64187 additions and 18822 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/tsl-api-reference/references/codegen/builtin/process.md
+129 -35
View File
@@ -4,7 +4,9 @@
声明：function
注销任务。该功能可以用来终止运行的WEB任务。
注销任务。该功能可以用来终止运行的WEB任务
<!-- tags: 进程 线程 process WEB -->
| 参数 | 类型 | 说明 |
| ---- | ------- | ----------------------------------------------------------------- |
@@ -24,7 +26,9 @@ echo dbglocalcancel(0), "\n";
声明：function
获得当前所有的任务列表以及堆栈信息，主要用于web等检查在运行中的任务。
获取当前所有的任务列表以及堆栈信息，主要用于web等检查在运行中的任务
<!-- tags: 进程 获取 查询 线程 process -->
返回：array,tablearray
@@ -40,7 +44,9 @@ echo length(dbglocalrunning()), "\n";
声明：function
暂停执行。
暂停执行
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| -------------- | ------- | --------------------------------------------------- |
@@ -62,7 +68,9 @@ echo "after\n";
声明：function
关闭一个句柄，如互斥锁，文件句柄等。
关闭一个句柄，如互斥锁，文件句柄等
<!-- tags: 进程 关闭 close 线程 process -->
| 参数 | 类型 | 说明 |
| -------- | ------- | -------------- |
@@ -83,7 +91,9 @@ echo sysCloseHandle(handle), "\n";
声明：function
获得解析器的真实命令行串。
获取解析器的真实命令行串
<!-- tags: 进程 获取 查询 线程 process -->
返回：string
@@ -99,7 +109,9 @@ echo sysCmdLine(), "\n";
声明：function
创建一个互斥锁。
创建一个互斥锁
<!-- tags: 进程 创建 生成 线程 process -->
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------ |
@@ -121,7 +133,9 @@ sysReleaseMutex(mutex);
声明：function
返回指定代码表示的系统错误信息。
返回指定代码表示的系统错误信息
<!-- tags: 进程 返回 获取 线程 process -->
| 参数 | 类型 | 说明 |
| ------ | ------- | -------------- |
@@ -141,7 +155,9 @@ echo sysErrorMessage(2), "\n";
声明：function
创建子进程。wait_exit 为真时等待进程退出并写回退出码；wait_ms 可省略。返回的进程句柄使用后应关闭。
创建子进程。wait_exit 为真时等待进程退出并写回退出码；wait_ms 可省略。返回的进程句柄使用后应关闭
<!-- tags: 进程 创建 生成 线程 process -->
| 参数 | 类型 | 说明 |
| ------------- | -------------- | -------------------------------------- |
@@ -174,7 +190,9 @@ fileDelete("", "child.tsl");
声明：function
删除指定进程的管道。参数缺省时，删除默认管道。
删除指定进程的管道。参数缺省时，删除默认管道
<!-- tags: 进程 删除 移除 线程 process -->
| 参数 | 类型 | 说明 |
| ---------------- | ---- | ---------------------- |
@@ -195,7 +213,9 @@ echo sysExecDeletePipe(), "\n";
声明：function
获取子进程的环境变量，应用于Sysexec创建的子进程。
获取子进程的环境变量，应用于Sysexec创建的子进程
<!-- tags: 进程 获取 查询 线程 process -->
返回：array of string
@@ -212,7 +232,9 @@ echo toStn(sysexecGetenvs()), "\n";
声明：function
创建Sysexec进程的管道。参数缺省时，默认创建读写管道。创建之后会与第一次被用的进程进行绑定，当有多个Sysexec进程时，可以创建多个管道分别进行读写操作。
创建Sysexec进程的管道。参数缺省时，默认创建读写管道。创建之后会与第一次被用的进程进行绑定，当有多个Sysexec进程时，可以创建多个管道分别进行读写操作
<!-- tags: 进程 创建 生成 线程 process -->
| 参数 | 类型 | 说明 |
| ------ | ------- | ------------------------------------------------------------------------------------------------ |
@@ -234,7 +256,9 @@ sysExecDeletePipe();
声明：function
读取 SysExec 子进程的管道输出；process_handle 可省略，省略时读取默认管道。
读取 SysExec 子进程的管道输出；process_handle 可省略，省略时读取默认管道
<!-- tags: 进程 读取 获取 线程 process -->
| 参数 | 类型 | 说明 |
| ---------------- | ------- | ---------------- |
@@ -270,7 +294,9 @@ fileDelete("", "child.tsl");
声明：function
设置后续 SysExec 子进程使用的环境变量。add_system_env 为 0 时不合并系统环境，1 时追加系统环境，2 时将系统环境置于其后。
设置后续 SysExec 子进程使用的环境变量。add_system_env 为 0 时不合并系统环境，1 时追加系统环境，2 时将系统环境置于其后
<!-- tags: 进程 设置 修改 线程 process -->
| 参数 | 类型 | 说明 |
| ---------------- | ---------- | ------------------------------------------ |
@@ -295,7 +321,9 @@ sysExecSetEnvs(nil, 0);
声明：function
向 SysExec 子进程的管道写入内容；process_handle 可省略，省略时写入默认管道。成功时返回写入长度，失败时返回 -1。
向 SysExec 子进程的管道写入内容；process_handle 可省略，省略时写入默认管道。成功时返回写入长度，失败时返回 -1
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| ---------------- | -------------- | ---------------- |
@@ -325,7 +353,9 @@ sysCloseHandle(handle);
声明：function
获取当前运行环境下指定环境变量的值。
获取当前运行环境下指定环境变量的值
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ------ | ------ | -------------------- |
@@ -346,7 +376,9 @@ echo sysgetenv("TSL_DOC_EXAMPLE"), "\n";
声明：function
获取当前运行环境的全部环境变量串。
获取当前运行环境的全部环境变量串
<!-- tags: 进程 获取 查询 线程 process -->
返回：array of string
@@ -362,7 +394,9 @@ echo length(sysGetenvs()), "\n";
声明：function
获得系统操作的最后一个返回代码。
获取系统操作的最后一个返回代码
<!-- tags: 进程 获取 查询 线程 process -->
返回：integer
@@ -378,7 +412,9 @@ echo sysGetLastError(), "\n";
声明：function
取得指定进程的命令行；失败时返回空字符串。
获取指定进程的命令行；失败时返回空字符串
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | --------- |
@@ -399,7 +435,9 @@ echo length(sysGetProcessCmdLine(sysProcessId())) > 0, "\n";
声明：function
取得指定进程的宽字符串命令行；失败时返回空字符串。
获取指定进程的宽字符串命令行；失败时返回空字符串
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | --------- |
@@ -422,6 +460,8 @@ echo length(sysGetProcessCmdLinew(sysProcessId())) > 0, "\n";
获取当前进程列表信息
<!-- tags: 进程 获取 查询 线程 process -->
返回：array,tablearray
### 示例
@@ -438,6 +478,8 @@ echo length(sysGetProcessList()), "\n";
获取当前进程列表信息，信息中字符串为宽字节字符串
<!-- tags: 进程 获取 查询 线程 process -->
返回：array,tablearray
### 示例
@@ -452,7 +494,9 @@ echo length(sysGetProcessListw()), "\n";
声明：function
取得指定进程的可执行文件路径；无法取得路径时返回进程名，失败时返回空字符串。
获取指定进程的可执行文件路径；无法取得路径时返回进程名，失败时返回空字符串
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | --------- |
@@ -473,7 +517,9 @@ echo length(sysGetProcessNamePath(sysProcessId())) > 0, "\n";
声明：function
取得指定进程的宽字符串可执行文件路径；失败时返回空字符串。
获取指定进程的宽字符串可执行文件路径；失败时返回空字符串
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | --------- |
@@ -494,7 +540,9 @@ echo length(sysGetProcessNamePathw(sysProcessId())) > 0, "\n";
声明：function
取得进程优先级并写入 priority。pid 可省略，缺省为当前进程；成功返回 0。
获取进程优先级并写入 priority。pid 可省略，缺省为当前进程；成功返回 0
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ---------- | ------- | ------------------------------ |
@@ -517,7 +565,9 @@ echo result = 0, "\n";
声明：function
获得进程的子进程列表
获取进程的子进程列表
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | ---------------------------------------------------------- |
@@ -539,6 +589,8 @@ echo toStn(sysGetSubProcesses(sysProcessId())), "\n";
获取线程名称
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------------------------------------------ |
| `tid` | integer | 可选。整数，线程ID。未指定时默认获取当前线程名称 |
@@ -560,6 +612,8 @@ echo sysGetThreadName(), "\n";
获取线程优先级
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | -------------------------------------------------- |
| `pri` | integer | 变参，整数，线程优先级 |
@@ -582,6 +636,8 @@ echo status, ":", priority, "\n";
获取进程内的线程列表
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | -------------------------------------------------------- |
| `pid` | integer | 可选。整数，进程ID。未指定时默认获取当前进程内的线程列表 |
@@ -600,7 +656,9 @@ echo toStn(sysGetThreads(sysProcessId())), "\n";
声明：function
Windows上获取进程id对应的句柄，Linux上获取指定文件ID的复制ID。得到的句柄可用函数FAQ：SysCloseHandle进行关闭。
Windows上获取进程id对应的句柄，Linux上获取指定文件ID的复制ID。得到的句柄可用函数FAQ：SysCloseHandle进行关闭
<!-- tags: 进程 线程 process ID FAQ -->
| 参数 | 类型 | 说明 |
| --------------- | ------- | ------------------------------------------------------------------- |
@@ -633,7 +691,9 @@ sysCloseHandle(handle);
声明：function
按进程 ID 终止进程。code 可省略，用于指定进程退出码。
按进程 ID 终止进程。code 可省略，用于指定进程退出码
<!-- tags: 进程 线程 process ID -->
| 参数 | 类型 | 说明 |
| ------ | ------- | ------------------ |
@@ -662,6 +722,8 @@ sysCloseHandle(handle);
支持在LINUX上手动删除掉因互斥支持产生的系统信号量以及临时目录的文件
<!-- tags: 进程 线程 process LINUX -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------ |
| `name` | string | 字符串，互斥锁名称 |
@@ -684,7 +746,9 @@ echo syslinuxkrnlclosemutex(mutex_name, 0), "\n";
声明：function
获得命令行参数个数。（不包括执行的自身.TSL参数）
获取命令行参数个数。（不包括执行的自身.TSL参数）
<!-- tags: 进程 获取 查询 线程 process -->
返回：integer
@@ -700,7 +764,9 @@ echo sysParamcount(), "\n";
声明：function
获得命令行的指定索引的参数值。
获取命令行的指定索引的参数值
<!-- tags: 进程 获取 查询 线程 process -->
| 参数 | 类型 | 说明 |
| ------- | ---- | ---------------------------------------------------------------------------------------------------------------------- |
@@ -722,6 +788,8 @@ echo sysParamStr(0), "\n";
根据进程句柄获取进程ID。在Linux上，返回和进程句柄值相同的整数
<!-- tags: 进程 线程 process ID -->
| 参数 | 类型 | 说明 |
| -------- | ------- | -------- |
| `handle` | integer | 进程句柄 |
@@ -744,6 +812,8 @@ sysCloseHandle(handle);
获取线程所属进程ID
<!-- tags: 进程 获取 查询 线程 process ID -->
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------ |
| `tid` | integer | 整数，线程ID |
@@ -762,7 +832,9 @@ echo sysPidOfTid(sysThreadId()), "\n";
声明：function
获得进程的父进程ID
获取进程的父进程ID
<!-- tags: 进程 获取 查询 线程 process ID -->
| 参数 | 类型 | 说明 |
| ----- | ------- | ------------------------------------------------------ |
@@ -782,7 +854,9 @@ echo sysPPid(sysProcessId()), "\n";
声明：function
获得运行的进程ID。
获取运行的进程ID
<!-- tags: 进程 获取 查询 线程 process ID -->
返回：integer
@@ -798,7 +872,9 @@ echo sysProcessId(), "\n";
声明：function
设置当前运行环境的指定环境变量的值。
设置当前运行环境的指定环境变量的值
<!-- tags: 进程 设置 修改 线程 process -->
| 参数 | 类型 | 说明 |
| ----------- | ------ | --------------------------- |
@@ -819,7 +895,9 @@ echo sysgetenv("TSL_DOC_EXAMPLE"), "\n";
声明：function
释放一个互斥锁。
释放一个互斥锁
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| ------- | ------- | ---------------- |
@@ -840,7 +918,9 @@ echo sysReleaseMutex(mutex), "\n";
声明：function
设置进程优先级。pid 可省略，缺省为当前进程；成功返回 0。
设置进程优先级。pid 可省略，缺省为当前进程；成功返回 0
<!-- tags: 进程 设置 修改 线程 process -->
| 参数 | 类型 | 说明 |
| ---------- | ------- | ------------------------------ |
@@ -866,6 +946,8 @@ echo get_result = 0 and set_result = 0, "\n";
设置线程名称
<!-- tags: 进程 设置 修改 线程 process -->
| 参数 | 类型 | 说明 |
| ------ | ------- | ------------------------------------------------ |
| `name` | string | 字符串，要设置的名称 |
@@ -888,6 +970,8 @@ echo status, ":", sysGetThreadName(), "\n";
设置线程优先级
<!-- tags: 进程 设置 修改 线程 process -->
| 参数 | 类型 | 说明 |
| ----- | ------- | -------------------------------------------- |
| `pri` | integer | 线程优先级 |
@@ -912,7 +996,9 @@ echo set_status, "\n";
声明：function
终止进程。
终止进程
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| ---------- | ------- | ------------------------------------------ |
@@ -936,7 +1022,9 @@ sysCloseHandle(handle);
声明：function
获得运行的线程ID。
获取运行的线程ID
<!-- tags: 进程 获取 查询 线程 process ID -->
返回：integer
@@ -952,7 +1040,9 @@ echo sysThreadId(), "\n";
声明：function
获取当前程序的线程ID。
获取当前程序的线程ID
<!-- tags: 进程 获取 查询 线程 process ID -->
返回：integer|int64
@@ -970,6 +1060,8 @@ echo sysThreadSelf(), "\n";
等待占有多个对象,例如互斥对象。支持windows和linux的进程
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| ------------ | ---------------- | -------------------------------------------------------------------------- |
| `objects` | array of integer | 一维数字数组，对象句柄数组 |
@@ -997,6 +1089,8 @@ sysCloseHandle(handle2);
等待占有一个对象,例如互斥对象。支持windows和linux的进程
<!-- tags: 进程 线程 process -->
| 参数 | 类型 | 说明 |
| --------- | ------- | ------------------------------------ |
| `object` | integer | 整数，对象名柄 |