Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix taos_init() return type #22475

Merged
merged 1 commit into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/en/14-reference/03-connector/03-cpp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The following describes the basic API, synchronous API, asynchronous API, subscr

The base API is used to do things like create database connections and provide a runtime environment for the execution of other APIs.

- `void taos_init()`
- `int taos_init()`

Initializes the runtime environment. If the API is not actively called, the driver will automatically call the API when `taos_connect()` is called, so the program generally does not need to call it manually.

Expand Down Expand Up @@ -514,4 +514,4 @@ In addition to writing data using the SQL method or the parameter binding API, w
- topics: a list of topics subscribed by consumers,need to be freed by tmq_list_destroy

**Return value**
- zero success,none zero failed, wrong message can be obtained through `char *tmq_err2str(int32_t code)`
- zero success,none zero failed, wrong message can be obtained through `char *tmq_err2str(int32_t code)`
4 changes: 2 additions & 2 deletions docs/zh/08-connector/10-cpp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ int taos_print_row(char *str, TAOS_ROW row, TAOS_FIELD *fields, int num_fields)

基础 API 用于完成创建数据库连接等工作,为其它 API 的执行提供运行时环境。

- `void taos_init()`
- `int taos_init()`

初始化运行环境。如果没有主动调用该 API,那么调用 `taos_connect()` 时驱动将自动调用该 API,故程序一般无需手动调用。

Expand Down Expand Up @@ -602,4 +602,4 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- topics: 获取的 topic 列表存储在这个结构中,接口内分配内存,需调用tmq_list_destroy释放

**返回值**
- 错误码,0成功,非0失败,可通过 `char *tmq_err2str(int32_t code)` 函数获取错误信息
- 错误码,0成功,非0失败,可通过 `char *tmq_err2str(int32_t code)` 函数获取错误信息