Help Center/ GaussDB/ Developer Guide(Distributed_3.x)/ Application Development Guide/ Development Based on ODBC/ ODBC Interface Reference/ SQLFreeHandle
Updated on 2024-05-07 GMT+08:00
View PDF
Share

SQLFreeHandle

Description

Releases resources associated with a specific environment, connection, or statement handle. It replaces the ODBC 2.x functions: SQLFreeEnv, SQLFreeConnect, and SQLFreeStmt.

Prototype

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

Parameters

Table 1 SQLFreeHandle parameters

Keyword

Description

HandleType

Type of handle to be freed by SQLFreeHandle. The value must be one of the following:

  • SQL_HANDLE_ENV
  • SQL_HANDLE_DBC
  • SQL_HANDLE_STMT
  • SQL_HANDLE_DESC

If none of them is the value of HandleType, SQLFreeHandle returns SQL_INVALID_HANDLE.

Handle

Name of the handle to be freed.

Return Value

  • SQL_SUCCESS indicates that the call succeeded.
  • SQL_SUCCESS_WITH_INFO indicates that some warning information is displayed.
  • SQL_ERROR indicates major errors, such as memory allocation and connection failures.
  • SQL_INVALID_HANDLE indicates that invalid handles were called. This value may also be returned by other APIs.

Precautions

If SQLFreeHandle returns SQL_ERROR, the handle is still valid.

Examples

See Examples.

Parent topic: ODBC Interface Reference