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 15:39:24 +08:00 committed by gccgdb1234
parent 147b29fe57
commit c1b36f554d
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -230,7 +230,7 @@ int taos_print_row(char *str, TAOS_ROW row, TAOS_FIELD *fields, int num_fields)
- `int taos_init()` - `int taos_init()`
- **接口说明**：初始化运行环境。如果没有主动调用该 API，那么调用 `taos_connect()` 时驱动将自动调用该 API，故程序一般无需手动调用。 - **接口说明**：初始化运行环境。如果没有主动调用该 API，那么调用 `taos_connect()` 时驱动将自动调用该 API，故程序一般无需手动调用。
- **返回值**：`0`：成功，`非0`：失败，可调用函数 taos_errstr(NULL) 获取更详细的错误信息。 - **返回值**：`0`：成功，非 `0`：失败，可调用函数 taos_errstr(NULL) 获取更详细的错误信息。
- `void taos_cleanup()` - `void taos_cleanup()`
- **接口说明**：清理运行环境，应用退出前应调用。 - **接口说明**：清理运行环境，应用退出前应调用。
@ -280,7 +280,7 @@ int taos_print_row(char *str, TAOS_ROW row, TAOS_FIELD *fields, int num_fields)
- **参数说明**： - **参数说明**：
- taos：[入参] 指向数据库连接的指针，数据库连接是通过 `taos_connect()` 函数建立。 - taos：[入参] 指向数据库连接的指针，数据库连接是通过 `taos_connect()` 函数建立。
- db：[入参] 数据库名称。 - db：[入参] 数据库名称。
- **返回值**：`0`：成功，`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功，非 `0`：失败，详情请参考错误码页面。
- `int taos_get_current_db(TAOS *taos, char *database, int len, int *required)` - `int taos_get_current_db(TAOS *taos, char *database, int len, int *required)`
- **接口说明**：获取当前数据库名称。 - **接口说明**：获取当前数据库名称。
@ -447,21 +447,21 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- sql：[入参] 需要解析的 SQL 语句。 - sql：[入参] 需要解析的 SQL 语句。
- length：[入参] 参数 sql 的长度。如果参数 length 大于 0，将使用此参数作为 SQL 语句的长度，如等于 0，将自动判断 SQL 语句的长度。 - length：[入参] 参数 sql 的长度。如果参数 length 大于 0，将使用此参数作为 SQL 语句的长度，如等于 0，将自动判断 SQL 语句的长度。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_bind_param(TAOS_STMT *stmt, TAOS_MULTI_BIND *bind)` - `int taos_stmt_bind_param(TAOS_STMT *stmt, TAOS_MULTI_BIND *bind)`
- **接口说明**：绑定参数到一个预编译的 SQL 语句。不如 `taos_stmt_bind_param_batch()` 效率高，但可以支持非 INSERT 类型的 SQL 语句。 - **接口说明**：绑定参数到一个预编译的 SQL 语句。不如 `taos_stmt_bind_param_batch()` 效率高，但可以支持非 INSERT 类型的 SQL 语句。
- **参数说明**： - **参数说明**：
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- bind：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了要绑定到 SQL 语句中的参数列表。需保证此数组中的元素数量和顺序与 SQL 语句中的参数完全一致。TAOS_MULTI_BIND 的使用方法与 MySQL 中的 MYSQL_BIND 类似。 - bind：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了要绑定到 SQL 语句中的参数列表。需保证此数组中的元素数量和顺序与 SQL 语句中的参数完全一致。TAOS_MULTI_BIND 的使用方法与 MySQL 中的 MYSQL_BIND 类似。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_set_tbname(TAOS_STMT* stmt, const char* name)` - `int taos_stmt_set_tbname(TAOS_STMT* stmt, const char* name)`
- **接口说明**：（2.1.1.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）当 SQL 语句中的表名使用了 `?` 占位时，可以使用此函数绑定一个具体的表名。 - **接口说明**：（2.1.1.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）当 SQL 语句中的表名使用了 `?` 占位时，可以使用此函数绑定一个具体的表名。
- **参数说明**： - **参数说明**：
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- name：[入参] 指向一个包含子表名称的字符串常量。 - name：[入参] 指向一个包含子表名称的字符串常量。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_set_tbname_tags(TAOS_STMT* stmt, const char* name, TAOS_MULTI_BIND* tags)` - `int taos_stmt_set_tbname_tags(TAOS_STMT* stmt, const char* name, TAOS_MULTI_BIND* tags)`
- **接口说明**：（2.1.2.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）当 SQL 语句中的表名和 TAGS 都使用了 `?` 占位时，可以使用此函数绑定具体的表名和具体的 TAGS 取值。最典型的使用场景是使用了自动建表功能的 INSERT 语句（目前版本不支持指定具体的 TAGS 列）。TAGS 参数中的列数量需要与 SQL 语句中要求的 TAGS 数量完全一致。 - **接口说明**：（2.1.2.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）当 SQL 语句中的表名和 TAGS 都使用了 `?` 占位时，可以使用此函数绑定具体的表名和具体的 TAGS 取值。最典型的使用场景是使用了自动建表功能的 INSERT 语句（目前版本不支持指定具体的 TAGS 列）。TAGS 参数中的列数量需要与 SQL 语句中要求的 TAGS 数量完全一致。
@ -469,24 +469,24 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- name：[入参] 指向一个包含子表名称的字符串常量。 - name：[入参] 指向一个包含子表名称的字符串常量。
- tags：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了子表标签的值。 - tags：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了子表标签的值。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_bind_param_batch(TAOS_STMT* stmt, TAOS_MULTI_BIND* bind)` - `int taos_stmt_bind_param_batch(TAOS_STMT* stmt, TAOS_MULTI_BIND* bind)`
- **接口说明**：（2.1.1.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）以多列的方式传递待绑定的数据，需要保证这里传递的数据列的顺序、列的数量与 SQL 语句中的 VALUES 参数完全一致。 - **接口说明**：（2.1.1.0 版本新增，仅支持用于替换 INSERT 语句中的参数值）以多列的方式传递待绑定的数据，需要保证这里传递的数据列的顺序、列的数量与 SQL 语句中的 VALUES 参数完全一致。
- **参数说明**： - **参数说明**：
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- bind：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了要批量绑定到 SQL 语句中的参数列表。 - bind：[入参] 指向一个有效的 TAOS_MULTI_BIND 结构体指针，该结构体包含了要批量绑定到 SQL 语句中的参数列表。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_add_batch(TAOS_STMT *stmt)` - `int taos_stmt_add_batch(TAOS_STMT *stmt)`
- **接口说明**：将当前绑定的参数加入批处理中，调用此函数后，可以再次调用 `taos_stmt_bind_param()` 或 `taos_stmt_bind_param_batch()` 绑定新的参数。需要注意，此函数仅支持 INSERT/IMPORT 语句，如果是 SELECT 等其他 SQL 语句，将返回错误。 - **接口说明**：将当前绑定的参数加入批处理中，调用此函数后，可以再次调用 `taos_stmt_bind_param()` 或 `taos_stmt_bind_param_batch()` 绑定新的参数。需要注意，此函数仅支持 INSERT/IMPORT 语句，如果是 SELECT 等其他 SQL 语句，将返回错误。
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_execute(TAOS_STMT *stmt)` - `int taos_stmt_execute(TAOS_STMT *stmt)`
- **接口说明**：执行准备好的语句。目前，一条语句只能执行一次。 - **接口说明**：执行准备好的语句。目前，一条语句只能执行一次。
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `int taos_stmt_affected_rows(TAOS_STMT *stmt)` - `int taos_stmt_affected_rows(TAOS_STMT *stmt)`
- **接口说明**：获取执行预编译 SQL 语句后受影响的行数。 - **接口说明**：获取执行预编译 SQL 语句后受影响的行数。
@ -506,7 +506,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- `int taos_stmt_close(TAOS_STMT *stmt)` - `int taos_stmt_close(TAOS_STMT *stmt)`
- **接口说明**：执行完毕，释放所有资源。 - **接口说明**：执行完毕，释放所有资源。
- stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。 - stmt：[入参] 指向一个有效的预编译的 SQL 语句对象指针。
- **返回值**：`0`：成功。`非0`：失败，详情请参考错误码页面。 - **返回值**：`0`：成功。非 `0`：失败，详情请参考错误码页面。
- `char * taos_stmt_errstr(TAOS_STMT *stmt)` - `char * taos_stmt_errstr(TAOS_STMT *stmt)`
- **接口说明**：（2.1.3.0 版本新增）用于在其他 STMT API 返回错误（返回错误码或空指针）时获取错误信息。 - **接口说明**：（2.1.3.0 版本新增）用于在其他 STMT API 返回错误（返回错误码或空指针）时获取错误信息。
@ -680,7 +680,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- **接口说明**：用于向 tmq_list_t 结构体中添加一个 topic。 - **接口说明**：用于向 tmq_list_t 结构体中添加一个 topic。
- list：[入参] 指向一个有效的 tmq_list_t 结构体指针，该结构体代表一个 TMQ 列表对象。 - list：[入参] 指向一个有效的 tmq_list_t 结构体指针，该结构体代表一个 TMQ 列表对象。
- topic：[入参] topic 名称。 - topic：[入参] topic 名称。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `void tmq_list_destroy(tmq_list_t *list)` - `void tmq_list_destroy(tmq_list_t *list)`
- **接口说明**：用于销毁 tmq_list_t 结构体，tmq_list_new 的结果需要通过该接口销毁。 - **接口说明**：用于销毁 tmq_list_t 结构体，tmq_list_new 的结果需要通过该接口销毁。
@ -707,18 +707,18 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- **接口说明**：用于订阅 topic 列表，消费完数据后，需调用 tmq_subscribe 取消订阅。 - **接口说明**：用于订阅 topic 列表，消费完数据后，需调用 tmq_subscribe 取消订阅。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- topic_list：[入参] 指向一个有效的 tmq_list_t 结构体指针，该结构体包含一个或多个主题名称。 - topic_list：[入参] 指向一个有效的 tmq_list_t 结构体指针，该结构体包含一个或多个主题名称。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `int32_t tmq_unsubscribe(tmq_t *tmq)` - `int32_t tmq_unsubscribe(tmq_t *tmq)`
- **接口说明**：用于取消订阅的 topic 列表。需与 tmq_subscribe 配合使用。 - **接口说明**：用于取消订阅的 topic 列表。需与 tmq_subscribe 配合使用。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `int32_t tmq_subscription(tmq_t *tmq, tmq_list_t **topic_list)` - `int32_t tmq_subscription(tmq_t *tmq, tmq_list_t **topic_list)`
- **接口说明**：用于获取订阅的 topic 列表。 - **接口说明**：用于获取订阅的 topic 列表。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- topic_list：[出参] 指向一个 tmq_list_t 结构体指针的指针，用于接收当前订阅的主题列表。 - topic_list：[出参] 指向一个 tmq_list_t 结构体指针的指针，用于接收当前订阅的主题列表。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `TAOS_RES *tmq_consumer_poll(tmq_t *tmq, int64_t timeout)` - `TAOS_RES *tmq_consumer_poll(tmq_t *tmq, int64_t timeout)`
- **接口说明**：用于轮询消费数据，每一个消费者，只能单线程调用该接口。 - **接口说明**：用于轮询消费数据，每一个消费者，只能单线程调用该接口。
@ -729,7 +729,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- `int32_t tmq_consumer_close(tmq_t *tmq)` - `int32_t tmq_consumer_close(tmq_t *tmq)`
- **接口说明**：用于关闭 tmq_t 结构体。需与 tmq_consumer_new 配合使用。 - **接口说明**：用于关闭 tmq_t 结构体。需与 tmq_consumer_new 配合使用。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `int32_t tmq_get_topic_assignment(tmq_t *tmq, const char *pTopicName, tmq_topic_assignment **assignment, int32_t *numOfAssignment)` - `int32_t tmq_get_topic_assignment(tmq_t *tmq, const char *pTopicName, tmq_topic_assignment **assignment, int32_t *numOfAssignment)`
- **接口说明**：返回当前 consumer 分配的 vgroup 的信息，每个 vgroup 的信息包括 vgId，wal 的最大最小 offset，以及当前消费到的 offset。 - **接口说明**：返回当前 consumer 分配的 vgroup 的信息，每个 vgroup 的信息包括 vgId，wal 的最大最小 offset，以及当前消费到的 offset。
@ -737,7 +737,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- pTopicName：[入参] 要查询分配信息的主题名称。 - pTopicName：[入参] 要查询分配信息的主题名称。
- assignment：[出参] 指向一个 tmq_topic_assignment 结构体指针的指针，用于接收分配信息。数据大小为 numOfAssignment，需要通过 tmq_free_assignment 接口释放。 - assignment：[出参] 指向一个 tmq_topic_assignment 结构体指针的指针，用于接收分配信息。数据大小为 numOfAssignment，需要通过 tmq_free_assignment 接口释放。
- numOfAssignment：[出参] 指向一个整数指针，用于接收分配给该 consumer 有效的 vgroup 个数。 - numOfAssignment：[出参] 指向一个整数指针，用于接收分配给该 consumer 有效的 vgroup 个数。
- **返回值**：`0`：成功。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `void tmq_free_assignment(tmq_topic_assignment* pAssignment)` - `void tmq_free_assignment(tmq_topic_assignment* pAssignment)`
- **接口说明**：返回当前consumer分配的vgroup的信息，每个vgroup的信息包括vgId，wal的最大最小offset，以及当前消费到的offset。 - **接口说明**：返回当前consumer分配的vgroup的信息，每个vgroup的信息包括vgId，wal的最大最小offset，以及当前消费到的offset。
@ -754,7 +754,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- **接口说明**：同步提交 TMQ 消费者对象处理的消息偏移量。 - **接口说明**：同步提交 TMQ 消费者对象处理的消息偏移量。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- msg：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了已处理的消息。如果为 NULL，提交当前 consumer 所有消费的 vgroup 的当前进度。 - msg：[入参] 指向一个有效的 TAOS_RES 结构体指针，该结构体包含了已处理的消息。如果为 NULL，提交当前 consumer 所有消费的 vgroup 的当前进度。
- **返回值**：`0`：成功，已经成功提交偏移量。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功，已经成功提交偏移量。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `void tmq_commit_async(tmq_t *tmq, const TAOS_RES *msg, tmq_commit_cb *cb, void *param)` - `void tmq_commit_async(tmq_t *tmq, const TAOS_RES *msg, tmq_commit_cb *cb, void *param)`
- **接口说明**：异步提交 TMQ 消费者对象处理的消息偏移量。 - **接口说明**：异步提交 TMQ 消费者对象处理的消息偏移量。
@ -767,7 +767,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- **接口说明**：同步提交 TMQ 消费者对象的特定主题和 vgroup 的偏移量。 - **接口说明**：同步提交 TMQ 消费者对象的特定主题和 vgroup 的偏移量。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- pTopicName：[入参] 要提交偏移量的主题名称。 - pTopicName：[入参] 要提交偏移量的主题名称。
- **返回值**：`0`：成功，已经成功提交偏移量。`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功，已经成功提交偏移量。非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `void tmq_commit_offset_async(tmq_t *tmq, const char *pTopicName, int32_t vgId, int64_t offset, tmq_commit_cb *cb, void *param)` - `void tmq_commit_offset_async(tmq_t *tmq, const char *pTopicName, int32_t vgId, int64_t offset, tmq_commit_cb *cb, void *param)`
- **接口说明**：异步提交 TMQ 消费者对象的特定主题和 vgroup 的偏移量。 - **接口说明**：异步提交 TMQ 消费者对象的特定主题和 vgroup 的偏移量。
@ -796,7 +796,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- pTopicName：[入参] 要查询当前位置的主题名称。 - pTopicName：[入参] 要查询当前位置的主题名称。
- vgId：[入参] 虚拟组 vgroup 的 ID。 - vgId：[入参] 虚拟组 vgroup 的 ID。
- offset：[入参] 虚拟组 vgroup 的 ID。 - offset：[入参] 虚拟组 vgroup 的 ID。
- **返回值**：`0`：成功，`非0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`0`：成功，非 `0`：失败，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `int64_t tmq_get_vgroup_offset(TAOS_RES* res)` - `int64_t tmq_get_vgroup_offset(TAOS_RES* res)`
- **接口说明**：从 TMQ 消费者获取的消息结果中提取虚拟组（vgroup）的当前消费数据位置的偏移量。 - **接口说明**：从 TMQ 消费者获取的消息结果中提取虚拟组（vgroup）的当前消费数据位置的偏移量。