xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_database_file_object.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
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
14If X is the name of a rollback or WAL-mode journal file that is passed
15into the xOpen method of sqlite3_vfs, then sqlite3_database_file_object(X)
16returns a pointer to the sqlite3_file object that represents
17the main database file.
18.Pp
19This routine is intended for use in custom VFS implementations only.
20It is not a general-purpose interface.
21The argument sqlite3_file_object(X) must be a filename pointer that
22has been passed into sqlite3_vfs.xOpen method where the
23flags parameter to xOpen contains one of the bits SQLITE_OPEN_MAIN_JOURNAL
24or SQLITE_OPEN_WAL.
25Any other use of this routine results in undefined and probably undesirable
26behavior.
27.Sh IMPLEMENTATION NOTES
28These declarations were extracted from the
29interface documentation at line 3857.
30.Bd -literal
31SQLITE_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