Difference between revisions of "OpenDBX/C API/odbx finish"
From Linuxnetworks
(header) |
(return values and error section) |
||
| Line 6: | Line 6: | ||
odbx_t* '''handle''' ) | odbx_t* '''handle''' ) | ||
| − | = Description | + | = Description = |
Frees all resources allocated by [[OpenDBX_init|odbx_init()]]. Be sure you invoked [[OpenDBX_unbind|odbx_unbind()]] before to avoid memory leaks. | Frees all resources allocated by [[OpenDBX_init|odbx_init()]]. Be sure you invoked [[OpenDBX_unbind|odbx_unbind()]] before to avoid memory leaks. | ||
| − | = Parameters | + | = Parameters = |
* handle: Connection object created by [[OpenDBX_init|odbx_init()]] | * handle: Connection object created by [[OpenDBX_init|odbx_init()]] | ||
| − | = Return values | + | = Return values = |
| − | + | '''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_error|odbx_error()]] and [[OpenDBX_error_type|odbx_error_type()]] to get further details. | |
| − | + | ||
| − | = Errors | + | = Errors = |
| − | + | ; -ODBX_ERR_PARAM : '''handle''' is NULL or the supplied connection object is invalid | |
| − | = See also | + | = See also = |
* [[OpenDBX_error]] | * [[OpenDBX_error]] | ||
Revision as of 22:33, 19 February 2007
#include <odbx.h>
int odbx_finish(
odbx_t* handle )
Description
Frees all resources allocated by odbx_init(). Be sure you invoked odbx_unbind() before to avoid memory leaks.
Parameters
- handle: Connection object created by odbx_init()
Return values
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
Back to Overview
