awtk/docs/manual/csv_row_t.md

94 lines
2.2 KiB
Markdown
Raw Normal View History

2023-12-26 19:09:36 +08:00
## csv\_row\_t
### 概述
行对象。
----------------------------------
### 函数
<p id="csv_row_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#csv_row_t_csv_row_count_cols">csv\_row\_count\_cols</a> | 获取列数。 |
| <a href="#csv_row_t_csv_row_get">csv\_row\_get</a> | 获取指定列的数据。 |
| <a href="#csv_row_t_csv_row_get_col">csv\_row\_get\_col</a> | 根据列名获取列号。 |
| <a href="#csv_row_t_csv_row_set">csv\_row\_set</a> | 修改指定列的数据。 |
#### csv\_row\_count\_cols 函数
-----------------------
* 函数功能:
> <p id="csv_row_t_csv_row_count_cols">获取列数。
* 函数原型:
```
uint32_t csv_row_count_cols (csv_row_t* row);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回列数。 |
| row | csv\_row\_t* | 行对象。 |
#### csv\_row\_get 函数
-----------------------
* 函数功能:
> <p id="csv_row_t_csv_row_get">获取指定列的数据。
* 函数原型:
```
const char* csv_row_get (csv_row_t* row, uint32_t col);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const char* | 返回数据。 |
| row | csv\_row\_t* | 行对象。 |
| col | uint32\_t | 列号。 |
#### csv\_row\_get\_col 函数
-----------------------
* 函数功能:
> <p id="csv_row_t_csv_row_get_col">根据列名获取列号。
* 函数原型:
```
int32_t csv_row_get_col (csv_row_t* row, const char* value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回列号。 |
| row | csv\_row\_t* | 行对象。 |
| value | const char* | 列名。 |
#### csv\_row\_set 函数
-----------------------
* 函数功能:
> <p id="csv_row_t_csv_row_set">修改指定列的数据。
* 函数原型:
```
ret_t csv_row_set (csv_row_t* row, uint32_t col, const char* value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| row | csv\_row\_t* | 行对象。 |
| col | uint32\_t | 列号。 |
| value | const char* | 值。 |