文档首页/ 云数据库 GaussDB/ 开发指南（分布式_2.x）/ API参考/ ODBC接口参考/ SQLFreeHandle
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

SQLFreeHandle

功能描述

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

原型

1
2
 
SQLRETURN SQLFreeHandle(SQLSMALLINT   HandleType,    
                        SQLHANDLE     Handle);

参数

表1 SQLFreeHandle参数

关键字

参数说明

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，句柄仍然有效。

示例

参见：示例

父主题： ODBC接口参考