xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3session_enable.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
2.Dt SQLITE3SESSION_ENABLE 3
3.Os
4.Sh NAME
5.Nm sqlite3session_enable
6.Nd Enable Or Disable A Session Object
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3session_enable
10.Fa "sqlite3_session *pSession"
11.Fa "int bEnable"
12.Fc
13.Sh DESCRIPTION
14Enable or disable the recording of changes by a session object.
15When enabled, a session object records changes made to the database.
16When disabled - it does not.
17A newly created session object is enabled.
18Refer to the documentation for sqlite3session_changeset()
19for further details regarding how enabling and disabling a session
20object affects the eventual changesets.
21.Pp
22Passing zero to this function disables the session.
23Passing a value greater than zero enables it.
24Passing a value less than zero is a no-op, and may be used to query
25the current state of the session.
26.Pp
27The return value indicates the final state of the session object: 0
28if the session is disabled, or 1 if it is enabled.
29.Sh SEE ALSO
30.Xr sqlite3session_changeset 3
31