xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_DESERIALIZE_FREEONCLOSE.3 (revision 7d62b00eb9ad855ffcd7da46b41e23feb5476fac)
1.Dd December 19, 2018
2.Dt SQLITE_DESERIALIZE_FREEONCLOSE 3
3.Os
4.Sh NAME
5.Nm SQLITE_DESERIALIZE_FREEONCLOSE ,
6.Nm SQLITE_DESERIALIZE_RESIZEABLE ,
7.Nm SQLITE_DESERIALIZE_READONLY
8.Nd Flags for sqlite3_deserialize()
9.Sh SYNOPSIS
10.Fd #define SQLITE_DESERIALIZE_FREEONCLOSE
11.Fd #define SQLITE_DESERIALIZE_RESIZEABLE
12.Fd #define SQLITE_DESERIALIZE_READONLY
13.Sh DESCRIPTION
14The following are allowed values for 6th argument (the F argument)
15to the sqlite3_deserialize(D,S,P,N,M,F)
16interface.
17.Pp
18The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
19in the P argument is held in memory obtained from sqlite3_malloc64()
20and that SQLite should take ownership of this memory and automatically
21free it when it has finished using it.
22Without this flag, the caller is responsible for freeing any dynamically
23allocated memory.
24.Pp
25The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed
26to grow the size of the database using calls to sqlite3_realloc64().
27This flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is
28also used.
29Without this flag, the deserialized database cannot increase in size
30beyond the number of bytes specified by the M parameter.
31.Pp
32The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database
33should be treated as read-only.
34.Sh SEE ALSO
35.Xr sqlite3_malloc 3
36