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/dotnet/platform.md
+97 -47
View File
@@ -6,9 +6,11 @@
从用户板块中删除名为bk_name的板块
| 参数 | 类型 | 说明 |
| --------- | ------ | ------------------ |
| `bk_name` | string | 字符串，板块名称 |
<!-- tags: 平台与客户端 删除 移除 -->
| 参数 | 类型 | 说明 |
| --------- | ------ | ---------------- |
| `bk_name` | string | 字符串，板块名称 |
返回：boolean
@@ -24,6 +26,8 @@ echo deleteBk("MySector"), "\n";
删除指定的用户数据
<!-- tags: 平台与客户端 删除 移除 -->
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------------------ |
| `table_name` | string | 要删除的用户数据全名称，字符串 |
@@ -60,6 +64,8 @@ echo listTable(), "\n";
当前运行的函数的名称
<!-- tags: 平台与客户端 -->
返回：string
### 示例
@@ -76,6 +82,8 @@ echo functionName(), "\n";
当前运行的函数的类型，即返回当前函数是公用函数还是用户函数
<!-- tags: 平台与客户端 -->
返回：integer
### 示例
@@ -92,10 +100,12 @@ echo functionType(), "\n";
返回函数在服务器中保存的版本号，可用于判断函数是否被修改过，也可与 `saveTable` 和 `loadTable` 配合使用
| 参数 | 类型 | 说明 |
| ------- | ------- | ---------- |
| `type` | integer | 函数类型 |
| `name` | string | 函数名称 |
<!-- tags: 平台与客户端 返回 获取 -->
| 参数 | 类型 | 说明 |
| ------ | ------- | -------- |
| `type` | integer | 函数类型 |
| `name` | string | 函数名称 |
返回：integer
@@ -112,6 +122,8 @@ echo version, "\n";
stm用户数据名称转码(十六进制)
<!-- tags: 平台与客户端 -->
| 参数 | 类型 | 说明 |
| ----- | ------ | -------------------------- |
| `str` | string | 字符串类型，十六进制字符串 |
@@ -131,7 +143,9 @@ echo hexToString(str), "\n";
声明：function
获得当前运行的模型是否以委托执行的后台模式运行
获取当前运行的模型是否以委托执行的后台模式运行
<!-- tags: 平台与客户端 获取 查询 -->
返回：boolean
@@ -147,6 +161,8 @@ echo isBackGround(), "\n";
返回用户数据的名称列表(一维数组)
<!-- tags: 平台与客户端 返回 获取 -->
返回：array
### 示例
@@ -161,10 +177,12 @@ echo listTable(), "\n";
提取用户数据，装入用户表，从name指定的位置将数据导出，table_type参数可省略，默认为0，0或省略时表示装入当前用户表，1表示装入系统表，即可导入系统账号system的用户数据
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------------------------ |
| `name` | string | 字符串，数据存储位置的名称 |
| `table_type` | bool | 可选，布尔类型，数据类型，默认为 0 |
<!-- tags: 平台与客户端 读取 获取 -->
| 参数 | 类型 | 说明 |
| ------------ | ------ | ---------------------------------- |
| `name` | string | 字符串，数据存储位置的名称 |
| `table_type` | bool | 可选，布尔类型，数据类型，默认为 0 |
返回：any
@@ -181,6 +199,8 @@ echo loadTable('testA'), "\n";
加载用户数据table_name，如若table_name非空，则返回table_name数据，否则返回空数组
<!-- tags: 平台与客户端 读取 获取 -->
| 参数 | 类型 | 说明 |
| ------------ | ------ | -------------------- |
| `table_name` | string | 字符串，数据文件名称 |
@@ -199,11 +219,13 @@ echo loadTableEx('repitle'), "\n";
保存用户板块，将品种数组保存到指定板块目录下，保存的板块名为bk_name，保存板块后，用户不能直接在客户端的用户板块中看到该板块，但是可以用getbk模型获取到，用户重新登录后可看到
| 参数 | 类型 | 说明 |
| --------- | ------ | ------------------------------------------ |
| `bk_name` | string | 字符串，板块名称 |
| `bk_dir` | string | 字符串，板块保存的目录 |
| `sample` | array | 一维数组，可以是股票、基金等品种代码列表 |
<!-- tags: 平台与客户端 写入 保存 -->
| 参数 | 类型 | 说明 |
| --------- | ------ | ---------------------------------------- |
| `bk_name` | string | 字符串，板块名称 |
| `bk_dir` | string | 字符串，板块保存的目录 |
| `sample` | array | 一维数组，可以是股票、基金等品种代码列表 |
返回：boolean
@@ -219,11 +241,13 @@ echo saveBk("MySector", "我的一级分类\\我的二级分类", array("SZ00000
保存用户数据到服务器，服务器为每一位用户保留一块存储区域，可以把自有数据保存进去，以备分析时使用
| 参数 | 类型 | 说明 |
| ------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | 存储位置的名称, 字符串类型 |
| `value` | any | 各种类型的数据，如 integer、string、array |
| `stream_type` | boolean | 新流格式，可缺省，缺省时根据前端的版本（2020年6月前的版本为旧版本，之后的为新版本）决定是否存储为新流格式，0指定原始流格式，1强制为新流格式 |
<!-- tags: 平台与客户端 写入 保存 -->
| 参数 | 类型 | 说明 |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | 存储位置的名称, 字符串类型 |
| `value` | any | 各种类型的数据，如 integer、string、array |
| `stream_type` | boolean | 新流格式，可缺省，缺省时根据前端的版本（2020年6月前的版本为旧版本，之后的为新版本）决定是否存储为新流格式，0指定原始流格式，1强制为新流格式 |
返回：integer
@@ -261,6 +285,8 @@ echo array(r1, r2, r3), "\n";
发送命令到客户端执行
<!-- tags: 平台与客户端 发送 提交 -->
| 参数 | 类型 | 说明 |
| ----------- | ------- | -------------------------- |
| `cmd_type` | string | 命令类型 |
@@ -269,7 +295,7 @@ echo array(r1, r2, r3), "\n";
| `cmd_data` | any | 命令数据 |
| `time_out` | integer | 超时的秒数，默认是300s超时 |
### cmd_type 取值
cmd_type 取值
- `Echo`：显示信息
- `Import`：导入数据
@@ -304,9 +330,11 @@ echo sendToClient("getdo", "return getSysParam('a') + getSysParam('b');", nil, p
将当前用户设置为指定用户，调用方需要相应权限，设置成功返回真
| 参数 | 类型 | 说明 |
| ----- | ------ | -------- |
| `uid` | string | 用户名 |
<!-- tags: 平台与客户端 设置 修改 -->
| 参数 | 类型 | 说明 |
| ----- | ------ | ------ |
| `uid` | string | 用户名 |
返回：bool
@@ -322,10 +350,12 @@ echo setUid(userName()), "\n";
以UID指定的用户执行EXP表达式，该EXP为隐式表达式，例如SUDO("system",DoSomeThing())，如用户需要用显式的表达式，采用SUDO(UID,Eval(Exp))即可，SUDO和User不一样，SUDO需要有权限，而且SUDO是完全以指定用户来执行，访问的数据资源等均以指定的UID来运行，与SetUID不一样的地方是SUDO执行完EXP后用户ID便恢复成原始的ID
| 参数 | 类型 | 说明 |
| ----- | ---------- | ---------------- |
| `uid` | string | 字符串，用户名 |
| `exp` | expression | 表达式 |
<!-- tags: 平台与客户端 UID EXP SUDO ID -->
| 参数 | 类型 | 说明 |
| ----- | ---------- | -------------- |
| `uid` | string | 字符串，用户名 |
| `exp` | expression | 表达式 |
返回：any
@@ -343,10 +373,12 @@ echo sudo(userName(), 1 + 1), "\n";
检查数据是否存在，测试是否存在指定name的数据，如果table_type为真则为测试系统数据表，即测试系统账号system是否存在name指定的数据，table_type缺省或为0
| 参数 | 类型 | 说明 |
| ------------ | ------- | -------------------------------------------------------------- |
| `name` | string | 字符串，数据存储位置的名称 |
| `table_type` | boolean | 可选，bool 类型，为假或者省略时装入当前用户表，否则装入系统表 |
<!-- tags: 平台与客户端 -->
| 参数 | 类型 | 说明 |
| ------------ | ------- | ------------------------------------------------------------- |
| `name` | string | 字符串，数据存储位置的名称 |
| `table_type` | boolean | 可选，bool 类型，为假或者省略时装入当前用户表，否则装入系统表 |
返回：boolean
@@ -362,6 +394,8 @@ echo testTable("testA"), "\n";
获取本地用户数据列表(仅用于自动存储在本地的STM数据)
<!-- tags: 平台与客户端 获取 查询 STM -->
| 参数 | 类型 | 说明 |
| ------------- | ------- | ---------------------- |
| `dir` | string | 字符串类型，路径 |
@@ -383,9 +417,11 @@ echo transFileName(dir, 0), "\n";
返回进程以及 TSLInterp.dll 的时间和大小信息，`n` 省略或为 0 时返回当前进程以及 TSLInterp.dll 的信息，`n` 为 1 时，在具备相应权限的情况下返回所有模块的信息
| 参数 | 类型 | 说明 |
| ---- | ------- | --------------------------------------------------------- |
| `n` | integer | 可选，信息类型，省略或为 0 返回进程信息，1 返回模块信息 |
<!-- tags: 平台与客户端 返回 获取 -->
| 参数 | 类型 | 说明 |
| ---- | ------- | ------------------------------------------------------- |
| `n` | integer | 可选，信息类型，省略或为 0 返回进程信息，1 返回模块信息 |
返回：array
@@ -399,7 +435,9 @@ echo length(tsModuleInfo()), "\n";
声明：function
获得当前运行的模型所在的运算服务器的标识
获取当前运行的模型所在的运算服务器的标识
<!-- tags: 平台与客户端 获取 查询 -->
返回：string
@@ -415,6 +453,8 @@ echo tsAppServer(), "\n";
返回平台设置的名字，如果没有设置，默认是ip:进程路径
<!-- tags: 平台与客户端 返回 获取 -->
返回：string
### 示例
@@ -427,7 +467,9 @@ echo tsAppServerName(), "\n";
声明：function
获得当前用户是否具备网格计算的权限
获取当前用户是否具备网格计算的权限
<!-- tags: 平台与客户端 获取 查询 -->
返回：boolean
@@ -441,11 +483,13 @@ echo tsCanGrid(), "\n";
声明：function
取得指定用户的函数对象，调用方必须拥有该用户的授权，返回对象后可通过成员函数名继续调用
获取指定用户的函数对象，调用方必须拥有该用户的授权，返回对象后可通过成员函数名继续调用
| 参数 | 类型 | 说明 |
| ------ | ------ | -------- |
| `name` | string | 用户名 |
<!-- tags: 平台与客户端 获取 查询 -->
| 参数 | 类型 | 说明 |
| ------ | ------ | ------ |
| `name` | string | 用户名 |
返回：any
@@ -461,10 +505,12 @@ echo length(user(userName()).FunctionName) > 0, "\n";
返回用户的配置信息，section为配置名，ret_type用于指定返回的类型，0为字符串，1为数字，2为日期类型，注：此函数为特殊用途
| 参数 | 类型 | 说明 |
| ---------- | ------- | ---------------- |
| `section` | string | 字符串，配置名 |
| `ret_type` | integer | 整数，返回类型 |
<!-- tags: 平台与客户端 返回 获取 -->
| 参数 | 类型 | 说明 |
| ---------- | ------- | -------------- |
| `section` | string | 字符串，配置名 |
| `ret_type` | integer | 整数，返回类型 |
返回：real|string|tdatetime
@@ -483,6 +529,8 @@ echo userConfig("example", 0), "\n";
上传用户数据，输入本地用户数据的路径及名称，通过该函数可上传至服务器
<!-- tags: 平台与客户端 -->
| 参数 | 类型 | 说明 |
| ------------- | ------- | ------------------------------ |
| `filedir` | string | 字符串类型，用户数据路径及名称 |
@@ -504,6 +552,8 @@ echo userDataUpLoad(filedir, 1), "\n";
返回当前的用户
<!-- tags: 平台与客户端 返回 获取 -->
返回：string
### 示例