Difference between revisions of "OpenDBX/C API/odbx unbind"
(→Description:) |
(description) |
||
| Line 6: | Line 6: | ||
odbx_t* '''handle''' ) | odbx_t* '''handle''' ) | ||
| − | = Description | + | = Description = |
| − | Releases the binding to the database and user | + | Releases the binding of the connection to the database and user associated by [[OpenDBX_bind|odbx_bind()]] to the supplied connection object. This is useful for switching to another database or binding to the database as a different user. It is also possible to set new connection related options before rebinding to the database server. If an open transaction exists while this function is executed in the firebird backend, it will be committed to the database and closed. The behavior of the other backends for open transactions may vary. |
| − | This function must be invoked before calling [[OpenDBX_finish|odbx_finish()]] to avoid memory leaks. | + | It's necessary to process all result sets returned by the database server before using this function. Otherwise, it might return an error depending on the native database client library and the backend module. This function must be invoked before calling [[OpenDBX_finish|odbx_finish()]] to avoid memory leaks and connections left open which may block resources needed later on. |
| − | + | The '''handle''' parameter have to be the connection object created and returned by [[OpenDBX_init|odbx_init()]]. It becomes invalid after it was supplied to [[OpenDBX_finish|odbx_finish()]] and '''odbx_unbind()''' will return an error in this case. | |
| − | + | = Return value = | |
| − | + | '''odbx_init()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to [[OpenDBX_error|odbx_error()]] and [[OpenDBX_error_type|odbx_error_type()]] to get further details. | |
| − | + | = Errors = | |
| − | + | ||
| − | + | ; -ODBX_ERR_PARAM : '''handle''' is NULL or the supplied connection object is invalid | |
| − | + | = See also = | |
| − | + | ||
| − | = See also | + | |
* [[OpenDBX_bind]] | * [[OpenDBX_bind]] | ||
Revision as of 22:20, 19 February 2007
#include <odbx.h>
int odbx_unbind(
odbx_t* handle )
Description
Releases the binding of the connection to the database and user associated by odbx_bind() to the supplied connection object. This is useful for switching to another database or binding to the database as a different user. It is also possible to set new connection related options before rebinding to the database server. If an open transaction exists while this function is executed in the firebird backend, it will be committed to the database and closed. The behavior of the other backends for open transactions may vary.
It's necessary to process all result sets returned by the database server before using this function. Otherwise, it might return an error depending on the native database client library and the backend module. This function must be invoked before calling odbx_finish() to avoid memory leaks and connections left open which may block resources needed later on.
The handle parameter have to be the connection object created and returned by odbx_init(). It becomes invalid after it was supplied to odbx_finish() and odbx_unbind() will return an error in this case.
Return value
odbx_init() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. 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
Back to Overview
