Help Center/ GaussDB/ Developer Guide(Distributed_2.x)/ API Reference/ ODBC Interface Reference/ SQLDisconnect
Updated on 2024-10-14 GMT+08:00
View PDF
Share

SQLDisconnect

Function

SQLDisconnect is used to close the connection associated with a database connection handle.

Prototype

1
 
SQLRETURN SQLDisconnect(SQLHDBC    ConnectionHandle);

Parameter

Table 1 SQLDisconnect parameters

Keyword

Parameter Description

ConnectionHandle

Connection handle, obtained from SQLAllocHandle.

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 SQLDisconnect returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, the application can call SQLGetDiagRec, with HandleType and Handle set to SQL_HANDLE_DBC and ConnectionHandle, respectively, to obtain the SQLSTATE value. The SQLSTATE value provides the detailed function calling information.

Example

See Examples.

Parent topic: ODBC Interface Reference