summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_filename_database.3
diff options
context:
space:
mode:
Diffstat (limited to 'static/netbsd/man3/sqlite3_filename_database.3')
-rw-r--r--static/netbsd/man3/sqlite3_filename_database.360
1 files changed, 60 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_filename_database.3 b/static/netbsd/man3/sqlite3_filename_database.3
new file mode 100644
index 00000000..7dfdfbdd
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_filename_database.3
@@ -0,0 +1,60 @@
+.Dd January 24, 2024
+.Dt SQLITE3_FILENAME_DATABASE 3
+.Os
+.Sh NAME
+.Nm sqlite3_filename_database ,
+.Nm sqlite3_filename_journal ,
+.Nm sqlite3_filename_wal
+.Nd translate filenames
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft const char *
+.Fo sqlite3_filename_database
+.Fa "sqlite3_filename"
+.Fc
+.Ft const char *
+.Fo sqlite3_filename_journal
+.Fa "sqlite3_filename"
+.Fc
+.Ft const char *
+.Fo sqlite3_filename_wal
+.Fa "sqlite3_filename"
+.Fc
+.Sh DESCRIPTION
+These routines are available to custom VFS implementations
+for translating filenames between the main database file, the journal
+file, and the WAL file.
+.Pp
+If F is the name of an sqlite database file, journal file, or WAL file
+passed by the SQLite core into the VFS, then sqlite3_filename_database(F)
+returns the name of the corresponding database file.
+.Pp
+If F is the name of an sqlite database file, journal file, or WAL file
+passed by the SQLite core into the VFS, or if F is a database filename
+obtained from
+.Fn sqlite3_db_filename ,
+then sqlite3_filename_journal(F) returns the name of the corresponding
+rollback journal file.
+.Pp
+If F is the name of an sqlite database file, journal file, or WAL file
+that was passed by the SQLite core into the VFS, or if F is a database
+filename obtained from
+.Fn sqlite3_db_filename ,
+then sqlite3_filename_wal(F) returns the name of the corresponding
+WAL file.
+.Pp
+In all of the above, if F is not the name of a database, journal or
+WAL filename passed into the VFS from the SQLite core and F is not
+the return value from
+.Fn sqlite3_db_filename ,
+then the result is undefined and is likely a memory access violation.
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 3826.
+.Bd -literal
+SQLITE_API const char *sqlite3_filename_database(sqlite3_filename);
+SQLITE_API const char *sqlite3_filename_journal(sqlite3_filename);
+SQLITE_API const char *sqlite3_filename_wal(sqlite3_filename);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3_db_filename 3