xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_file.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_FILE 3
3.Os
4.Sh NAME
5.Nm sqlite3_file ,
6.Nm sqlite3_file
7.Nd OS interface open file handle
8.Sh SYNOPSIS
9.In sqlite3.h
10.Vt typedef struct sqlite3_file sqlite3_file;
11.Vt struct sqlite3_file ;
12.Sh DESCRIPTION
13An sqlite3_file object represents an open file in the OS interface layer.
14Individual OS interface implementations will want to subclass this
15object by appending additional fields for their own use.
16The pMethods entry is a pointer to an sqlite3_io_methods
17object that defines methods for performing I/O operations on the open
18file.
19.Sh IMPLEMENTATION NOTES
20These declarations were extracted from the
21interface documentation at line 718.
22.Bd -literal
23typedef struct sqlite3_file sqlite3_file;
24struct sqlite3_file {
25  const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
26};
27.Ed
28.Sh SEE ALSO
29.Xr sqlite3_io_methods 3 ,
30.Xr sqlite3_vfs 3
31