Difference between revisions of "OpenDBX/C API/odbx finish"

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(→‎Description:)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
'''Frees connection resources'''
  
−
  int odbx_finish(
+
  #include <opendbx/api.h>
−
    odbx_t* handle )
+
  
−
= Description: =
+
int '''odbx_finish'''(
 +
    odbx_t* '''''handle''''' )
  
−
Frees all resources allocated by [[OpenDBX_init|odbx_init()]]. Be sure you invoked [[OpenDBX_unbind|odbx_unbind()]] before to avoid memory leaks.
+
== Description ==
  
−
= Parameters: =
+
[[OpenDBX/API/odbx_finish|odbx_finish]]() is responsible for freeing all resources allocated by [[OpenDBX/API/odbx_init|odbx_init]]() and finally may shut down the connection to the database server. It must not be invoked before calling [[OpenDBX/API/odbx_unbind|odbx_unbind]]() to avoid memory leaks and open connection descriptors on the client and server side which may block necessary resources later on.
  
−
* handle: Connection object created by [[OpenDBX_init|odbx_init()]]
+
The '''''handle''''' parameter has to be the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]](). It becomes invalid after it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]]() for the first time and the function will return an error for all further invocations.
  
−
= Return values: =
+
== Return value ==
  
−
* ODBX_ERR_SUCCESS on success
+
[[OpenDBX/API/odbx_finish|odbx_finish]]() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if '''''handle''''' is invalid or one of the operations couldn't be completed successfully by the backend module. Possible error codes are listed in the error section and they can be feed to [[OpenDBX/API/odbx_error|odbx_error]]() and [[OpenDBX/API/odbx_error_type|odbx_error_type]]() to get further details.
−
* Less than zero if an error occured
+
  
−
= Errors: =
+
== Errors ==
  
−
* -ODBX_ERR_PARAM: Parameter is NULL or the structure is invalid
+
; -ODBX_ERR_PARAM : '''''handle''''' is NULL or the supplied connection object is invalid
  
 +
== See also ==
  
−
----
+
* [[OpenDBX/API/odbx_error|odbx_error]]()
−
Back to [[OpenDBX API|Overview]]
+
* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 +
* [[OpenDBX/API/odbx_init|odbx_init]]()
 +
* [[OpenDBX/API/odbx_unbind|odbx_unbind]]()

Latest revision as of 23:13, 28 April 2009

Frees connection resources 

#include <opendbx/api.h>

int odbx_finish(
    odbx_t* handle )

Description

odbx_finish() is responsible for freeing all resources allocated by odbx_init() and finally may shut down the connection to the database server. It must not be invoked before calling odbx_unbind() to avoid memory leaks and open connection descriptors on the client and server side which may block necessary resources later on.

The handle parameter has to be the connection object created and returned by odbx_init(). It becomes invalid after it was supplied to odbx_finish() for the first time and the function will return an error for all further invocations.

Return value

odbx_finish() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if handle is invalid or one of the operations couldn't be completed successfully by the backend module. Possible error codes are listed in the error section and they can be feed to odbx_error() and odbx_error_type() to get further details.

Errors

-ODBX_ERR_PARAM 
handle is NULL or the supplied connection object is invalid

See also

Retrieved from "https://www.linuxnetworks.de/doc/index.php?title=OpenDBX/C_API/odbx_finish&oldid=3618"