summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3session_enable.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/sqlite3session_enable.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/sqlite3session_enable.3')
-rw-r--r--static/netbsd/man3/sqlite3session_enable.338
1 files changed, 38 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3session_enable.3 b/static/netbsd/man3/sqlite3session_enable.3
new file mode 100644
index 00000000..16d61f17
--- /dev/null
+++ b/static/netbsd/man3/sqlite3session_enable.3
@@ -0,0 +1,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