awtk/docs/manual/cmd_exec_event_t.md

108 lines
2.9 KiB
Markdown
Raw Normal View History

2020-06-24 12:06:19 +08:00
## cmd\_exec\_event\_t
### 概述
![image](images/cmd_exec_event_t_0.png)
对象执行命令的事件。
----------------------------------
### 函数
<p id="cmd_exec_event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2023-06-29 10:56:20 +08:00
| <a href="#cmd_exec_event_t_cmd_exec_event_cast">cmd\_exec\_event\_cast</a> | 把event对象转cmd_exec_event_t对象。 |
2020-06-24 12:06:19 +08:00
| <a href="#cmd_exec_event_t_cmd_exec_event_init">cmd\_exec\_event\_init</a> | 初始命令执行事件。 |
### 属性
<p id="cmd_exec_event_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#cmd_exec_event_t_args">args</a> | const char* | 命令的参数。 |
2021-02-23 11:17:36 +08:00
| <a href="#cmd_exec_event_t_can_exec">can\_exec</a> | bool\_t | 标识命令是否可以执行(适用于CAN_EXEC)。 |
2020-06-24 12:06:19 +08:00
| <a href="#cmd_exec_event_t_name">name</a> | const char* | 命令的名称。 |
| <a href="#cmd_exec_event_t_result">result</a> | ret\_t | 执行结果(适用于EXECED)。 |
#### cmd\_exec\_event\_cast 函数
-----------------------
* 函数功能:
2023-06-29 10:56:20 +08:00
> <p id="cmd_exec_event_t_cmd_exec_event_cast">把event对象转cmd_exec_event_t对象。
2020-06-24 12:06:19 +08:00
* 函数原型:
```
cmd_exec_event_t* cmd_exec_event_cast (event_t* event);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | cmd\_exec\_event\_t* | 返回event对象。 |
| event | event\_t* | event对象。 |
#### cmd\_exec\_event\_init 函数
-----------------------
* 函数功能:
> <p id="cmd_exec_event_t_cmd_exec_event_init">初始命令执行事件。
* 函数原型:
```
event_t* cmd_exec_event_init (cmd_exec_event_t* event, uint32_t type, const char* name, const char* args);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t* | 返回event对象。 |
| event | cmd\_exec\_event\_t* | event对象。 |
| type | uint32\_t | 事件类型。 |
| name | const char* | 命令名。 |
| args | const char* | 命令参数。 |
#### args 属性
-----------------------
> <p id="cmd_exec_event_t_args">命令的参数。
* 类型const char*
2020-08-04 21:45:46 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### can\_exec 属性
-----------------------
2021-02-23 11:17:36 +08:00
> <p id="cmd_exec_event_t_can_exec">标识命令是否可以执行(适用于CAN_EXEC)。
2020-08-04 21:45:46 +08:00
* 类型bool\_t
2020-06-24 12:06:19 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### name 属性
-----------------------
> <p id="cmd_exec_event_t_name">命令的名称。
* 类型const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### result 属性
-----------------------
> <p id="cmd_exec_event_t_result">执行结果(适用于EXECED)。
* 类型ret\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |