summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_file_control.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_file_control.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/sqlite3_file_control.3')
-rw-r--r--static/netbsd/man3/sqlite3_file_control.368
1 files changed, 68 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_file_control.3 b/static/netbsd/man3/sqlite3_file_control.3
new file mode 100644
index 00000000..028f5c76
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_file_control.3
@@ -0,0 +1,68 @@
+.Dd January 24, 2024
+.Dt SQLITE3_FILE_CONTROL 3
+.Os
+.Sh NAME
+.Nm sqlite3_file_control
+.Nd low-Level control of database files
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft int
+.Fo sqlite3_file_control
+.Fa "sqlite3*"
+.Fa "const char *zDbName"
+.Fa "int op"
+.Fa "void*"
+.Fc
+.Sh DESCRIPTION
+The
+.Fn sqlite3_file_control
+interface makes a direct call to the xFileControl method for the sqlite3_io_methods
+object associated with a particular database identified by the second
+argument.
+The name of the database is "main" for the main database or "temp"
+for the TEMP database, or the name that appears after the AS keyword
+for databases that are added using the ATTACH SQL command.
+A NULL pointer can be used in place of "main" to refer to the main
+database file.
+The third and fourth parameters to this routine are passed directly
+through to the second and third parameters of the xFileControl method.
+The return value of the xFileControl method becomes the return value
+of this routine.
+.Pp
+A few opcodes for
+.Fn sqlite3_file_control
+are handled directly by the SQLite core and never invoke the sqlite3_io_methods.xFileControl
+method.
+The SQLITE_FCNTL_FILE_POINTER value for the
+op parameter causes a pointer to the underlying sqlite3_file
+object to be written into the space pointed to by the 4th parameter.
+The SQLITE_FCNTL_JOURNAL_POINTER works
+similarly except that it returns the sqlite3_file object
+associated with the journal file instead of the main database.
+The SQLITE_FCNTL_VFS_POINTER opcode returns
+a pointer to the underlying sqlite3_vfs object for the file.
+The SQLITE_FCNTL_DATA_VERSION returns the
+data version counter from the pager.
+.Pp
+If the second parameter (zDbName) does not match the name of any open
+database file, then SQLITE_ERROR is returned.
+This error code is not remembered and will not be recalled by
+.Fn sqlite3_errcode
+or
+.Fn sqlite3_errmsg .
+The underlying xFileControl method might also return SQLITE_ERROR.
+There is no way to distinguish between an incorrect zDbName and an
+SQLITE_ERROR return from the underlying xFileControl method.
+.Pp
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 8221.
+.Bd -literal
+SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3_errcode 3 ,
+.Xr sqlite3_file 3 ,
+.Xr sqlite3_io_methods 3 ,
+.Xr sqlite3_vfs 3 ,
+.Xr SQLITE_FCNTL_LOCKSTATE 3