Home | History | Annotate | Line # | Download | only in man
      1 .Dd April 29, 2026
      2 .Dt SQLITE3_DATABASE_FILE_OBJECT 3
      3 .Os
      4 .Sh NAME
      5 .Nm sqlite3_database_file_object
      6 .Nd database file corresponding to a journal
      7 .Sh SYNOPSIS
      8 .In sqlite3.h
      9 .Ft sqlite3_file *
     10 .Fo sqlite3_database_file_object
     11 .Fa "const char*"
     12 .Fc
     13 .Sh DESCRIPTION
     14 If X is the name of a rollback or WAL-mode journal file that is passed
     15 into the xOpen method of sqlite3_vfs, then sqlite3_database_file_object(X)
     16 returns a pointer to the sqlite3_file object that represents
     17 the main database file.
     18 .Pp
     19 This routine is intended for use in custom VFS implementations only.
     20 It is not a general-purpose interface.
     21 The argument sqlite3_file_object(X) must be a filename pointer that
     22 has been passed into sqlite3_vfs.xOpen method where the
     23 flags parameter to xOpen contains one of the bits SQLITE_OPEN_MAIN_JOURNAL
     24 or SQLITE_OPEN_WAL.
     25 Any other use of this routine results in undefined and probably undesirable
     26 behavior.
     27 .Sh IMPLEMENTATION NOTES
     28 These declarations were extracted from the
     29 interface documentation at line 4108.
     30 .Bd -literal
     31 SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);
     32 .Ed
     33 .Sh SEE ALSO
     34 .Xr sqlite3_file 3 ,
     35 .Xr sqlite3_vfs 3 ,
     36 .Xr SQLITE_OPEN_READONLY 3
     37