xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_blob_reopen.3 (revision 627f7eb200a4419d89b531d55fccd2ee3ffdcde0)
1.Dd December 19, 2018
2.Dt SQLITE3_BLOB_REOPEN 3
3.Os
4.Sh NAME
5.Nm sqlite3_blob_reopen
6.Nd Move a BLOB Handle to a New Row
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3_blob_reopen
10.Fa "sqlite3_blob *"
11.Fa "sqlite3_int64"
12.Fc
13.Sh DESCRIPTION
14This function is used to move an existing BLOB handle so
15that it points to a different row of the same database table.
16The new row is identified by the rowid value passed as the second argument.
17Only the row can be changed.
18The database, table and column on which the blob handle is open remain
19the same.
20Moving an existing BLOB handle to a new row is faster than
21closing the existing handle and opening a new one.
22.Pp
23The new row must meet the same criteria as for sqlite3_blob_open()
24- it must exist and there must be either a blob or text value stored
25in the nominated column.
26If the new row is not present in the table, or if it does not contain
27a blob or text value, or if another error occurs, an SQLite error code
28is returned and the blob handle is considered aborted.
29All subsequent calls to sqlite3_blob_read(), sqlite3_blob_write()
30or sqlite3_blob_reopen() on an aborted blob handle
31immediately return SQLITE_ABORT.
32Calling sqlite3_blob_bytes() on an aborted blob
33handle always returns zero.
34.Pp
35This function sets the database handle error code and message.
36.Sh SEE ALSO
37.Xr sqlite3_blob 3 ,
38.Xr sqlite3_blob_bytes 3 ,
39.Xr sqlite3_blob_open 3 ,
40.Xr sqlite3_blob_read 3 ,
41.Xr sqlite3_blob_reopen 3 ,
42.Xr sqlite3_blob_write 3
43