xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_filename.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_FILENAME 3
3.Os
4.Sh NAME
5.Nm sqlite3_filename
6.Nd file name
7.Sh SYNOPSIS
8.In sqlite3.h
9.Vt typedef const char *sqlite3_filename;
10.Sh DESCRIPTION
11Type sqlite3_filename is used by SQLite to pass filenames
12to the xOpen method of a VFS.
13It may be cast to (const char*) and treated as a normal, nul-terminated,
14UTF-8 buffer containing the filename, but may also be passed to special
15APIs such as:
16.Bl -bullet
17.It
18sqlite3_filename_database()
19.It
20sqlite3_filename_journal()
21.It
22sqlite3_filename_wal()
23.It
24sqlite3_uri_parameter()
25.It
26sqlite3_uri_boolean()
27.It
28sqlite3_uri_int64()
29.It
30sqlite3_uri_key()
31.El
32.Pp
33.Sh IMPLEMENTATION NOTES
34These declarations were extracted from the
35interface documentation at line 1275.
36.Bd -literal
37typedef const char *sqlite3_filename;
38.Ed
39