1odbx_lo_close(3)                    OpenDBX                   odbx_lo_close(3)
2
3
4

NAME

6       odbx_lo_close - Closes a large object reference
7

SYNOPSIS

9       #include <opendbx/api.h>
10
11
12       int odbx_lo_close (odbx_lo_t* lo);
13

DESCRIPTION

15       This  function  commits  any changes made by odbx_lo_write() and closes
16       the open large object handle. To ommit calling this  function  on  open
17       large  object handles will result in memory leaks as the data structure
18       and dependent memory aren't freed.
19
20       The lo parameter has to be the large object handle created and returned
21       by odbx_lo_open() via its second parameter. It becomes invalid after it
22       was supplied to odbx_lo_close() and this function will return an  error
23       in this case.
24

RETURN VALUE

26       odbx_lo_close()  returns ODBX_ERR_SUCCESS, or an error code whose value
27       is less than zero if one of the operations couldn't be  completed  suc‐
28       cessfully.  Possible  error  codes  are listed in the error section and
29       they can be feed to odbx_error() and odbx_error_type() to  get  further
30       details.
31

ERRORS

33       -ODBX_ERR_BACKEND
34              The native database library couldn't close the large object suc‐
35              cessfully
36
37       -ODBX_ERR_HANDLE
38              lo is NULL or the supplied large object handle is invalid
39

SEE ALSO

41       odbx_lo_open()
42
43
44
45                                2 February 2021               odbx_lo_close(3)