xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_SERIALIZE_NOCOPY.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE_SERIALIZE_NOCOPY 3
3.Os
4.Sh NAME
5.Nm SQLITE_SERIALIZE_NOCOPY
6.Nd flags for sqlite3_serialize
7.Sh SYNOPSIS
8.In sqlite3.h
9.Fd #define SQLITE_SERIALIZE_NOCOPY
10.Sh DESCRIPTION
11Zero or more of the following constants can be OR-ed together for the
12F argument to sqlite3_serialize(D,S,P,F).
13.Pp
14SQLITE_SERIALIZE_NOCOPY means that
15.Fn sqlite3_serialize
16will return a pointer to contiguous in-memory database that it is currently
17using, without making a copy of the database.
18If SQLite is not currently using a contiguous in-memory database, then
19this option causes
20.Fn sqlite3_serialize
21to return a NULL pointer.
22SQLite will only be using a contiguous in-memory database if it has
23been initialized by a prior call to
24.Fn sqlite3_deserialize .
25.Sh IMPLEMENTATION NOTES
26These declarations were extracted from the
27interface documentation at line 10686.
28.Bd -literal
29#define SQLITE_SERIALIZE_NOCOPY 0x001   /* Do no memory allocations */
30.Ed
31.Sh SEE ALSO
32.Xr sqlite3_deserialize 3 ,
33.Xr sqlite3_serialize 3
34