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