xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_blob_close.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_BLOB_CLOSE 3
3.Os
4.Sh NAME
5.Nm sqlite3_blob_close
6.Nd close a BLOB handle
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_blob_close
11.Fa "sqlite3_blob *"
12.Fc
13.Sh DESCRIPTION
14This function closes an open BLOB handle.
15The BLOB handle is closed unconditionally.
16Even if this routine returns an error code, the handle is still closed.
17.Pp
18If the blob handle being closed was opened for read-write access, and
19if the database is in auto-commit mode and there are no other open
20read-write blob handles or active write statements, the current transaction
21is committed.
22If an error occurs while committing the transaction, an error code
23is returned and the transaction rolled back.
24.Pp
25Calling this function with an argument that is not a NULL pointer or
26an open blob handle results in undefined behavior.
27Calling this routine with a null pointer (such as would be returned
28by a failed call to
29.Fn sqlite3_blob_open )
30is a harmless no-op.
31Otherwise, if this function is passed a valid open blob handle, the
32values returned by the sqlite3_errcode() and sqlite3_errmsg() functions
33are set before returning.
34.Sh IMPLEMENTATION NOTES
35These declarations were extracted from the
36interface documentation at line 7801.
37.Bd -literal
38SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
39.Ed
40.Sh SEE ALSO
41.Xr sqlite3_blob 3 ,
42.Xr sqlite3_blob_open 3
43