summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_status.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/sqlite3_status.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/sqlite3_status.3')
-rw-r--r--static/netbsd/man3/sqlite3_status.363
1 files changed, 63 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_status.3 b/static/netbsd/man3/sqlite3_status.3
new file mode 100644
index 00000000..ef6ab345
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_status.3
@@ -0,0 +1,63 @@
+.Dd January 24, 2024
+.Dt SQLITE3_STATUS 3
+.Os
+.Sh NAME
+.Nm sqlite3_status ,
+.Nm sqlite3_status64
+.Nd SQLite runtime status
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft int
+.Fo sqlite3_status
+.Fa "int op"
+.Fa "int *pCurrent"
+.Fa "int *pHighwater"
+.Fa "int resetFlag"
+.Fc
+.Ft int
+.Fo sqlite3_status64
+.Fa "int op"
+.Fa "sqlite3_int64 *pCurrent"
+.Fa "sqlite3_int64 *pHighwater"
+.Fa "int resetFlag"
+.Fc
+.Sh DESCRIPTION
+These interfaces are used to retrieve runtime status information about
+the performance of SQLite, and optionally to reset various highwater
+marks.
+The first argument is an integer code for the specific parameter to
+measure.
+Recognized integer codes are of the form SQLITE_STATUS_....
+The current value of the parameter is returned into *pCurrent.
+The highest recorded value is returned in *pHighwater.
+If the resetFlag is true, then the highest record value is reset after
+*pHighwater is written.
+Some parameters do not record the highest value.
+For those parameters nothing is written into *pHighwater and the resetFlag
+is ignored.
+Other parameters record only the highwater mark and not the current
+value.
+For these latter parameters nothing is written into *pCurrent.
+.Pp
+The sqlite3_status() and sqlite3_status64() routines return SQLITE_OK
+on success and a non-zero error code on failure.
+.Pp
+If either the current value or the highwater mark is too large to be
+represented by a 32-bit integer, then the values returned by sqlite3_status()
+are undefined.
+.Pp
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 8514.
+.Bd -literal
+SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
+SQLITE_API int sqlite3_status64(
+ int op,
+ sqlite3_int64 *pCurrent,
+ sqlite3_int64 *pHighwater,
+ int resetFlag
+);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3_db_status 3 ,
+.Xr SQLITE_STATUS_MEMORY_USED 3