NAME
odbx_lo_close - Closes a large object reference
SYNOPSIS
FC#include <opendbx/api.h>F[0]
FCint odbx_lo_closeF[0] FC(odbx_lo_t* lo);F[0]
DESCRIPTION
This function commits any changes made by FCodbx_lo_writeF[0]() and closes the open large object handle. To ommit calling this function on open large object handles will result in memory leaks as the data structure and dependent memory aren't freed.
The FCloF[0] parameter has to be the large object handle created and returned by FCodbx_lo_openF[0]() via its second parameter. It becomes invalid after it was supplied to FCodbx_lo_closeF[0]() and this function will return an error in this case.
RETURN VALUE
FCodbx_lo_closeF[0]() returns FCODBX_ERR_SUCCESSF[0], 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 FCodbx_errorF[0]() and FCodbx_error_typeF[0]() to get further details.
ERRORS
- -FCODBX_ERR_BACKENDF[0]
-
The native database library couldn't close the large object successfully
- -FCODBX_ERR_HANDLEF[0]
-
FCloF[0] is NULL or the supplied large object handle is invalid
SEE ALSO
FCodbx_lo_openF[0]()