Updated: 2022/Sep/29

Please read Privacy Policy. It's for your privacy.


SQLITE3_FILENAME_DATABASE(3)                          Library Functions Manual

NAME
     sqlite3_filename_database, sqlite3_filename_journal, sqlite3_filename_wal
     - translate filenames

SYNOPSIS
     #include <sqlite3.h>

     const char *
     sqlite3_filename_database(sqlite3_filename);

     const char *
     sqlite3_filename_journal(sqlite3_filename);

     const char *
     sqlite3_filename_wal(sqlite3_filename);

DESCRIPTION
     These routines are available to custom VFS implementations for
     translating filenames between the main database file, the journal file,
     and the WAL file.

     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.

     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 sqlite3_db_filename(), then sqlite3_filename_journal(F)
     returns the name of the corresponding rollback journal file.

     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 sqlite3_db_filename(), then
     sqlite3_filename_wal(F) returns the name of the corresponding WAL file.

     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 sqlite3_db_filename(), then the result is undefined and is
     likely a memory access violation.

IMPLEMENTATION NOTES
     These declarations were extracted from the interface documentation at
     line 3826.

     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);

SEE ALSO
     sqlite3_db_filename(3)

NetBSD 10.99                    August 24, 2023                   NetBSD 10.99