1odbx_finish(3)                      OpenDBX                     odbx_finish(3)
2
3
4

NAME

6       odbx_finish - Frees connection resources
7

SYNOPSIS

9       #include <opendbx/api.h>
10
11
12       int odbx_finish (odbx_t* handle);
13

DESCRIPTION

15       odbx_finish()  is  responsible  for  freeing all resources allocated by
16       odbx_init() and finally may shut down the connection  to  the  database
17       server.  It  must  not be invoked before calling odbx_unbind() to avoid
18       memory leaks and open connection descriptors on the client  and  server
19       side which may block necessary resources later on.
20
21       The  handle  parameter  has to be the connection object created and re‐
22       turned by odbx_init(). It becomes invalid  after  it  was  supplied  to
23       odbx_finish()  for the first time and the function will return an error
24       for all further invocations.
25

RETURN VALUE

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

ERRORS

34       -ODBX_ERR_PARAM
35              handle is NULL or the supplied connection object is invalid
36

SEE ALSO

38       odbx_error(), odbx_error_type(), odbx_init(), odbx_unbind()
39
40
41
42                                 20 July 2023                   odbx_finish(3)
Impressum