GaussDB-SQLFreeHandle

40 阅读1分钟

GaussDB-SQLFreeHandle

功能描述

释放与指定环境、连接、语句或描述符相关联的资源,它替代了ODBC 2.x函数SQLFreeEnv、SQLFreeConnect及SQLFreeStmt。

原型

| ``` SQLRETURN SQLFreeHandle(SQLSMALLINT HandleType, SQLHANDLE Handle);

| ------------------------------------------------------------------------------------------------------------- |

#### 参数

| **关键字**    | **参数说明**                                                                                                                                                          |
| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| HandleType | SQLFreeHandle要释放的句柄类型。必须为下列值之一:-   SQL_HANDLE_ENV
-   SQL_HANDLE_DBC
-   SQL_HANDLE_STMT
-   SQL_HANDLE_DESC如果HandleType不是其中之一,SQLFreeHandle返回SQL_INVALID_HANDLE。 |
| Handle     | 要释放的句柄。                                                                                                                                                           |

#### 返回值

-   SQL_SUCCESS:表示调用正确。
-   SQL_SUCCESS_WITH_INFO:表示会有一些警告信息。
-   SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。
-   SQL_INVALID_HANDLE:表示调用无效句柄。其他API的返回值同理。

#### 注意事项

如果SQLFreeHandle返回SQL_ERROR,句柄仍然有效。

#### 示例

请参见:[示例](https://doc.hcs.huawei.com/db/zh-cn/gaussdbqlh/24.1.30/devg-dist/gaussdb-12-0097.html#ZH-CN_TOPIC_0000001911584961)

更多详情请参考GaussDB 文档中心:<https://doc.hcs.huawei.com/db/zh-cn/gaussdbqlh/24.1.30/productdesc/qlh_03_0001.html>