awtk/docs/manual/error_event_t.md
2020-02-14 17:58:18 +08:00

83 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## error\_event\_t
### 概述
![image](images/error_event_t_0.png)
执行完成事件。
----------------------------------
### 函数
<p id="error_event_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#error_event_t_error_event_cast">error\_event\_cast</a> | 把event对象转error_event_t对象主要给脚本语言使用。 |
| <a href="#error_event_t_error_event_init">error\_event\_init</a> | 初始error event。 |
### 属性
<p id="error_event_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#error_event_t_code">code</a> | int32\_t | 错误码。 |
| <a href="#error_event_t_message">message</a> | const char* | 错误信息。 |
#### error\_event\_cast 函数
-----------------------
* 函数功能:
> <p id="error_event_t_error_event_cast">把event对象转error_event_t对象主要给脚本语言使用。
* 函数原型:
```
error_event_t* error_event_cast (event_t* event);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | error\_event\_t* | 返回event对象。 |
| event | event\_t* | event对象。 |
#### error\_event\_init 函数
-----------------------
* 函数功能:
> <p id="error_event_t_error_event_init">初始error event。
* 函数原型:
```
event_t* error_event_init (error_event_t* event, int32_t code, const char* message);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | event\_t* | 返回event对象。 |
| event | error\_event\_t* | event对象。 |
| code | int32\_t | 错误码。 |
| message | const char* | 错误消息。 |
#### code 属性
-----------------------
> <p id="error_event_t_code">错误码。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
#### message 属性
-----------------------
> <p id="error_event_t_message">错误信息。
* 类型const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |