awtk/docs/manual/value_t.md

## value\_t
### 概述
 一个通用数据类型，用来存放整数、浮点数、字符串和其它对象。

 在C/C++中，一般不需动态创建对象，直接声明并初始化即可。如：

 ```c
 value_t v;
 value_set_int(&v, 100);
 ```

> 在脚本语言中，需要动态创建对象。


### 函数
<p id="value_t_methods">

| 函数名称 | 说明 | 
| -------- | ------------ | 
| <a href="#value_t_value_bool">value\_bool</a> | 获取类型为bool的值。 |
| <a href="#value_t_value_copy">value\_copy</a> | 拷贝value的值。 |
| <a href="#value_t_value_create">value\_create</a> | 创建value对象。 |
| <a href="#value_t_value_destroy">value\_destroy</a> | 销毁value对象。 |
| <a href="#value_t_value_double">value\_double</a> | 获取类型为double的值。 |
| <a href="#value_t_value_equal">value\_equal</a> | 判断两个value是否相同。 |
| <a href="#value_t_value_float">value\_float</a> | 获取类型为float\_t的值。 |
| <a href="#value_t_value_float32">value\_float32</a> | 获取类型为float的值。 |
| <a href="#value_t_value_int">value\_int</a> | 转换为int的值。 |
| <a href="#value_t_value_int16">value\_int16</a> | 获取类型为int16的值。 |
| <a href="#value_t_value_int32">value\_int32</a> | 获取类型为int32的值。 |
| <a href="#value_t_value_int64">value\_int64</a> | 获取类型为int64的值。 |
| <a href="#value_t_value_int8">value\_int8</a> | 获取类型为int8的值。 |
| <a href="#value_t_value_is_null">value\_is\_null</a> | 判断value是否为空值。 |
| <a href="#value_t_value_pointer">value\_pointer</a> | 获取类型为pointer的值。 |
| <a href="#value_t_value_set_bool">value\_set\_bool</a> | 设置类型为bool的值。 |
| <a href="#value_t_value_set_double">value\_set\_double</a> | 设置类型为double的值。 |
| <a href="#value_t_value_set_float">value\_set\_float</a> | 设置类型为float\_t的值。 |
| <a href="#value_t_value_set_float32">value\_set\_float32</a> | 设置类型为float的值。 |
| <a href="#value_t_value_set_int">value\_set\_int</a> | 设置类型为int的值。 |
| <a href="#value_t_value_set_int16">value\_set\_int16</a> | 设置类型为int16的值。 |
| <a href="#value_t_value_set_int32">value\_set\_int32</a> | 设置类型为int32的值。 |
| <a href="#value_t_value_set_int64">value\_set\_int64</a> | 设置类型为int64的值。 |
| <a href="#value_t_value_set_int8">value\_set\_int8</a> | 设置类型为int8的值。 |
| <a href="#value_t_value_set_pointer">value\_set\_pointer</a> | 设置类型为pointer的值。 |
| <a href="#value_t_value_set_str">value\_set\_str</a> | 设置类型为字符串的值。 |
| <a href="#value_t_value_set_uint16">value\_set\_uint16</a> | 设置类型为uint16的值。 |
| <a href="#value_t_value_set_uint32">value\_set\_uint32</a> | 设置类型为uint32的值。 |
| <a href="#value_t_value_set_uint64">value\_set\_uint64</a> | 设置类型为uint64的值。 |
| <a href="#value_t_value_set_uint8">value\_set\_uint8</a> | 设置类型为uint8的值。 |
| <a href="#value_t_value_set_wstr">value\_set\_wstr</a> | 设置类型为宽字符串的值。 |
| <a href="#value_t_value_str">value\_str</a> | 获取类型为字符串的值。 |
| <a href="#value_t_value_uint16">value\_uint16</a> | 获取类型为uint16的值。 |
| <a href="#value_t_value_uint32">value\_uint32</a> | 获取类型为uint32的值。 |
| <a href="#value_t_value_uint64">value\_uint64</a> | 获取类型为uint64的值。 |
| <a href="#value_t_value_uint8">value\_uint8</a> | 获取类型为uint8的值。 |
| <a href="#value_t_value_wstr">value\_wstr</a> | 获取类型为宽字符串的值。 |
#### value\_bool 函数
-----------------------

* 函数功能：

> <p id="value_t_value_bool"> 获取类型为bool的值。




* 函数原型：

```
bool_t value_bool (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_copy 函数
-----------------------

* 函数功能：

> <p id="value_t_value_copy"> 拷贝value的值。




* 函数原型：

```
ret_t value_copy (value_t* dst, value_t* src);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| dst | value\_t* | 目的value对象。 |
| src | value\_t* | 源value对象。 |
#### value\_create 函数
-----------------------

* 函数功能：

> <p id="value_t_value_create"> 创建value对象。




* 函数原型：

```
value_t* value_create ();
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | 对象。 |
#### value\_destroy 函数
-----------------------

* 函数功能：

> <p id="value_t_value_destroy"> 销毁value对象。




* 函数原型：

```
ret_t value_destroy (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| v | value\_t* | value对象。 |
#### value\_double 函数
-----------------------

* 函数功能：

> <p id="value_t_value_double"> 获取类型为double的值。




* 函数原型：

```
double value_double (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | double | 值。 |
| v | value\_t* | value对象。 |
#### value\_equal 函数
-----------------------

* 函数功能：

> <p id="value_t_value_equal"> 判断两个value是否相同。




* 函数原型：

```
bool_t value_equal (value_t* value, value_t* other);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 为空值返回TRUE，否则返回FALSE。 |
| value | value\_t* | value对象。 |
| other | value\_t* | value对象。 |
#### value\_float 函数
-----------------------

* 函数功能：

> <p id="value_t_value_float"> 获取类型为float\_t的值。




* 函数原型：

```
float_t value_float (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_float32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_float32"> 获取类型为float的值。




* 函数原型：

```
float value_float32 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 值。 |
| v | value\_t* | value对象。 |
#### value\_int 函数
-----------------------

* 函数功能：

> <p id="value_t_value_int"> 转换为int的值。




* 函数原型：

```
int value_int (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int | 值。 |
| v | value\_t* | value对象。 |
#### value\_int16 函数
-----------------------

* 函数功能：

> <p id="value_t_value_int16"> 获取类型为int16的值。




* 函数原型：

```
int16_t value_int16 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int16\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_int32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_int32"> 获取类型为int32的值。




* 函数原型：

```
int32_t value_int32 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_int64 函数
-----------------------

* 函数功能：

> <p id="value_t_value_int64"> 获取类型为int64的值。




* 函数原型：

```
int64_t value_int64 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int64\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_int8 函数
-----------------------

* 函数功能：

> <p id="value_t_value_int8"> 获取类型为int8的值。




* 函数原型：

```
int8_t value_int8 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int8\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_is\_null 函数
-----------------------

* 函数功能：

> <p id="value_t_value_is_null"> 判断value是否为空值。




* 函数原型：

```
bool_t value_is_null (value_t* value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 为空值返回TRUE，否则返回FALSE。 |
| value | value\_t* | value对象。 |
#### value\_pointer 函数
-----------------------

* 函数功能：

> <p id="value_t_value_pointer"> 获取类型为pointer的值。




* 函数原型：

```
void* value_pointer (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void* | 值。 |
| v | value\_t* | value对象。 |
#### value\_set\_bool 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_bool"> 设置类型为bool的值。




* 函数原型：

```
value_t* value_set_bool (value_t* v, bool_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | bool\_t | 待设置的值。 |
#### value\_set\_double 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_double"> 设置类型为double的值。




* 函数原型：

```
value_t* value_set_double (value_t* v, double value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | double | 待设置的值。 |
#### value\_set\_float 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_float"> 设置类型为float\_t的值。




* 函数原型：

```
value_t* value_set_float (value_t* v, float_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | float\_t | 待设置的值。 |
#### value\_set\_float32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_float32"> 设置类型为float的值。




* 函数原型：

```
value_t* value_set_float32 (value_t* v, float value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | float | 待设置的值。 |
#### value\_set\_int 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_int"> 设置类型为int的值。




* 函数原型：

```
value_t* value_set_int (value_t* v, int32_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | int32\_t | 待设置的值。 |
#### value\_set\_int16 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_int16"> 设置类型为int16的值。




* 函数原型：

```
value_t* value_set_int16 (value_t* v, int16_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | int16\_t | 待设置的值。 |
#### value\_set\_int32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_int32"> 设置类型为int32的值。




* 函数原型：

```
value_t* value_set_int32 (value_t* v, int32_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | int32\_t | 待设置的值。 |
#### value\_set\_int64 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_int64"> 设置类型为int64的值。




* 函数原型：

```
value_t* value_set_int64 (value_t* v, int64_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | int64\_t | 待设置的值。 |
#### value\_set\_int8 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_int8"> 设置类型为int8的值。




* 函数原型：

```
value_t* value_set_int8 (value_t* v, int8_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | int8\_t | 待设置的值。 |
#### value\_set\_pointer 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_pointer"> 设置类型为pointer的值。




* 函数原型：

```
value_t* value_set_pointer (value_t* v, pointer_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | pointer\_t | 待设置的值。 |
#### value\_set\_str 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_str"> 设置类型为字符串的值。




* 函数原型：

```
value_t* value_set_str (value_t* v, const char* value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | const char* | 待设置的值。 |
#### value\_set\_uint16 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_uint16"> 设置类型为uint16的值。




* 函数原型：

```
value_t* value_set_uint16 (value_t* v, uint16_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | uint16\_t | 待设置的值。 |
#### value\_set\_uint32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_uint32"> 设置类型为uint32的值。




* 函数原型：

```
value_t* value_set_uint32 (value_t* v, uint32_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | uint32\_t | 待设置的值。 |
#### value\_set\_uint64 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_uint64"> 设置类型为uint64的值。




* 函数原型：

```
value_t* value_set_uint64 (value_t* v, uint64_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | uint64\_t | 待设置的值。 |
#### value\_set\_uint8 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_uint8"> 设置类型为uint8的值。




* 函数原型：

```
value_t* value_set_uint8 (value_t* v, uint8_t value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | uint8\_t | 待设置的值。 |
#### value\_set\_wstr 函数
-----------------------

* 函数功能：

> <p id="value_t_value_set_wstr"> 设置类型为宽字符串的值。




* 函数原型：

```
value_t* value_set_wstr (value_t* v, const wchar_t* value);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | value\_t* | value对象本身。 |
| v | value\_t* | value对象。 |
| value | const wchar\_t* | 待设置的值。 |
#### value\_str 函数
-----------------------

* 函数功能：

> <p id="value_t_value_str"> 获取类型为字符串的值。




* 函数原型：

```
const char* value_str (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const char* | 值。 |
| v | value\_t* | value对象。 |
#### value\_uint16 函数
-----------------------

* 函数功能：

> <p id="value_t_value_uint16"> 获取类型为uint16的值。




* 函数原型：

```
uint16_t value_uint16 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint16\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_uint32 函数
-----------------------

* 函数功能：

> <p id="value_t_value_uint32"> 获取类型为uint32的值。




* 函数原型：

```
uint32_t value_uint32 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_uint64 函数
-----------------------

* 函数功能：

> <p id="value_t_value_uint64"> 获取类型为uint64的值。




* 函数原型：

```
uint64_t value_uint64 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint64\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_uint8 函数
-----------------------

* 函数功能：

> <p id="value_t_value_uint8"> 获取类型为uint8的值。




* 函数原型：

```
int8_t value_uint8 (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int8\_t | 值。 |
| v | value\_t* | value对象。 |
#### value\_wstr 函数
-----------------------

* 函数功能：

> <p id="value_t_value_wstr"> 获取类型为宽字符串的值。




* 函数原型：

```
const wchar_t* value_wstr (value_t* v);
```

* 参数说明：

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const wchar\_t* | 值。 |
| v | value\_t* | value对象。 |