odbx_lo_close - Man Page

Closes a large object reference

Synopsis

#include <opendbx/api.h>

int odbx_lo_close (odbx_lo_t* lo);

Description

This function commits any changes made by odbx_lo_write() 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 lo parameter has to be the large object handle created and returned by odbx_lo_open() via its second parameter. It becomes invalid after it was supplied to odbx_lo_close() and this function will return an error in this case.

Return Value

odbx_lo_close() 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_BACKEND

The native database library couldn't close the large object successfully

-ODBX_ERR_HANDLE

lo is NULL or the supplied large object handle is invalid

See Also

odbx_lo_open()

Referenced By

odbx_lo_open(3), odbx_lo_read(3), odbx_lo_write(3).

20 July 2023 OpenDBX