blob: 16d61f17c3198d342778a9360d00893680bb2a90 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
.Dd January 24, 2024
.Dt SQLITE3SESSION_ENABLE 3
.Os
.Sh NAME
.Nm sqlite3session_enable
.Nd enable or disable a session object
.Sh SYNOPSIS
.In sqlite3.h
.Ft int
.Fo sqlite3session_enable
.Fa "sqlite3_session *pSession"
.Fa "int bEnable"
.Fc
.Sh DESCRIPTION
Enable or disable the recording of changes by a session object.
When enabled, a session object records changes made to the database.
When disabled - it does not.
A newly created session object is enabled.
Refer to the documentation for
.Fn sqlite3session_changeset
for further details regarding how enabling and disabling a session
object affects the eventual changesets.
.Pp
Passing zero to this function disables the session.
Passing a value greater than zero enables it.
Passing a value less than zero is a no-op, and may be used to query
the current state of the session.
.Pp
The return value indicates the final state of the session object: 0
if the session is disabled, or 1 if it is enabled.
.Sh IMPLEMENTATION NOTES
These declarations were extracted from the
interface documentation at line 11051.
.Bd -literal
SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
.Ed
.Sh SEE ALSO
.Xr sqlite3session_changeset 3
|
