xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

The Connector section of the official website reconstructs the C language interface description

This commit is contained in:
Yaming Pei 2024-08-03 14:44:27 +08:00 committed by gccgdb1234
parent 2f5eaec0b2
commit 147b29fe57
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/zh/14-reference/05-connector/10-cpp.mdx
View File

@ -811,12 +811,12 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- `TAOS *tmq_get_connect(tmq_t *tmq)` - `TAOS *tmq_get_connect(tmq_t *tmq)`
- **接口说明**：从 TMQ 消费者对象中获取与 TDengine 数据库的连接句柄。 - **接口说明**：从 TMQ 消费者对象中获取与 TDengine 数据库的连接句柄。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- **返回值**：非NULL`：成功，返回一个 TAOS * 类型的指针，指向与 TDengine 数据库的连接句柄。`NULL`：失败，非法的输入参数。 - **返回值**：非 `NULL`：成功，返回一个 TAOS * 类型的指针，指向与 TDengine 数据库的连接句柄。`NULL`：失败，非法的输入参数。
- `const char *tmq_get_table_name(TAOS_RES *res)` - `const char *tmq_get_table_name(TAOS_RES *res)`
- **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的的表名。 - **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的的表名。
- res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。 - res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。
- **返回值**：非NULL`：成功，返回一个 const char * 类型的指针，指向表名字符串。`NULL`：失败，非法的输入参数。 - **返回值**：非 `NULL`：成功，返回一个 const char * 类型的指针，指向表名字符串。`NULL`：失败，非法的输入参数。
- `tmq_res_t tmq_get_res_type(TAOS_RES *res)` - `tmq_res_t tmq_get_res_type(TAOS_RES *res)`
- **接口说明**：从 TMQ 消费者获取的消息结果中获取消息类型。 - **接口说明**：从 TMQ 消费者获取的消息结果中获取消息类型。
@ -835,9 +835,9 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- `const char *tmq_get_topic_name(TAOS_RES *res)` - `const char *tmq_get_topic_name(TAOS_RES *res)`
- **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的 topic 名称。 - **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的 topic 名称。
- res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。 - res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。
- **返回值**：非NULL`：成功，返回一个 const char * 类型的指针，指向 topic 名称字符串。`NULL`：失败，非法的输入参数。 - **返回值**：非 `NULL`：成功，返回一个 const char * 类型的指针，指向 topic 名称字符串。`NULL`：失败，非法的输入参数。
- `const char *tmq_get_db_name(TAOS_RES *res)` - `const char *tmq_get_db_name(TAOS_RES *res)`
- **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的数据库名称。 - **接口说明**：从 TMQ 消费者获取的消息结果中获取所属的数据库名称。
- res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。 - res：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了从 TMQ 消费者轮询得到的消息。
- **返回值**：非NULL`：成功，返回一个 const char * 类型的指针，指向数据库名称字符串。`NULL`：失败，非法的输入参数。 - **返回值**：非 `NULL`：成功，返回一个 const char * 类型的指针，指向数据库名称字符串。`NULL`：失败，非法的输入参数。