awtk/docs/manual/date_time_t.md
2018-12-27 18:01:15 +08:00

187 lines
4.3 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.

## date\_time\_t
### 概述
日期时间。
> 在嵌入式平台中在系统初始时需要调用date\_time\_set\_impl设置实际获取系统时间的函数。
### 函数
<p id="date_time_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#date_time_t_date_time_create">date\_time\_create</a> | 创建date_time对象并初始为当前日期和时间(一般供脚本语言中使用)。 |
| <a href="#date_time_t_date_time_date_time_set_impl">date\_time\_date\_time\_set\_impl</a> | 设置获取当前日期和时间的函数。 |
| <a href="#date_time_t_date_time_destroy">date\_time\_destroy</a> | 销毁date_time对象(一般供脚本语言中使用)。 |
| <a href="#date_time_t_date_time_init">date\_time\_init</a> | 初始为当前日期和时间。 |
### 属性
<p id="date_time_t_properties">
| 名属性称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#date_time_t_day">day</a> | int32\_t | 日(1-31)。 |
| <a href="#date_time_t_hour">hour</a> | int32\_t | 时(0 - 23)。 |
| <a href="#date_time_t_minute">minute</a> | int32\_t | 分(0 - 59)。 |
| <a href="#date_time_t_month">month</a> | int32\_t | 月(1-12)。 |
| <a href="#date_time_t_second">second</a> | int32\_t | 秒(0 - 59)。 |
| <a href="#date_time_t_year">year</a> | int32\_t | 年。 |
#### date\_time\_create 函数
-----------------------
* 函数功能:
> <p id="date_time_t_date_time_create"> 创建date_time对象并初始为当前日期和时间(一般供脚本语言中使用)。
* 函数原型:
```
date_time_t* date_time_create ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | date\_time\_t* | 返回date\_time对象。 |
#### date\_time\_date\_time\_set\_impl 函数
-----------------------
* 函数功能:
> <p id="date_time_t_date_time_date_time_set_impl"> 设置获取当前日期和时间的函数。
* 函数原型:
```
ret_t date_time_date_time_set_impl (date_time_get_now_t date_time_get_now);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| date\_time\_get\_now | date\_time\_get\_now\_t | 获取当前日期和时间的函数。 |
#### date\_time\_destroy 函数
-----------------------
* 函数功能:
> <p id="date_time_t_date_time_destroy"> 销毁date_time对象(一般供脚本语言中使用)。
* 函数原型:
```
ret_t date_time_destroy (date_time_t* dt);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| dt | date\_time\_t* | date\_time对象。 |
#### date\_time\_init 函数
-----------------------
* 函数功能:
> <p id="date_time_t_date_time_init"> 初始为当前日期和时间。
* 函数原型:
```
date_time_t* date_time_init (date_time_t* dt);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | date\_time\_t* | 返回date\_time对象。 |
| dt | date\_time\_t* | date\_time对象。 |
#### day 属性
-----------------------
> <p id="date_time_t_day"> 日(1-31)。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### hour 属性
-----------------------
> <p id="date_time_t_hour"> 时(0 - 23)。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### minute 属性
-----------------------
> <p id="date_time_t_minute"> 分(0 - 59)。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### month 属性
-----------------------
> <p id="date_time_t_month"> 月(1-12)。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### second 属性
-----------------------
> <p id="date_time_t_second"> 秒(0 - 59)。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### year 属性
-----------------------
> <p id="date_time_t_year"> 年。
* 类型int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |