xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_blob_bytes.3 (revision 897be3a4bac39d8b2e92077bf29f4a2e67d31983)
1.Dd January 24, 2024
2.Dt SQLITE3_BLOB_BYTES 3
3.Os
4.Sh NAME
5.Nm sqlite3_blob_bytes
6.Nd return the size of an open BLOB
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_blob_bytes
11.Fa "sqlite3_blob *"
12.Fc
13.Sh DESCRIPTION
14Returns the size in bytes of the BLOB accessible via the successfully
15opened BLOB handle in its only argument.
16The incremental blob I/O routines can only read or overwriting existing
17blob content; they cannot change the size of a blob.
18.Pp
19This routine only works on a BLOB handle which has been
20created by a prior successful call to
21.Fn sqlite3_blob_open
22and which has not been closed by
23.Fn sqlite3_blob_close .
24Passing any other pointer in to this routine results in undefined and
25probably undesirable behavior.
26.Sh IMPLEMENTATION NOTES
27These declarations were extracted from the
28interface documentation at line 7824.
29.Bd -literal
30SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
31.Ed
32.Sh SEE ALSO
33.Xr sqlite3_blob 3 ,
34.Xr sqlite3_blob_close 3 ,
35.Xr sqlite3_blob_open 3
36