51 lines
1.8 KiB
Groff
51 lines
1.8 KiB
Groff
.Dd March 11, 2017
|
|
.Dt SQLITE3_FILE_CONTROL 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm sqlite3_file_control
|
|
.Nd Low-Level Control Of Database Files
|
|
.Sh SYNOPSIS
|
|
.Ft int
|
|
.Fo sqlite3_file_control
|
|
.Fa "sqlite3*"
|
|
.Fa "const char *zDbName"
|
|
.Fa "int op"
|
|
.Fa "void*"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
The sqlite3_file_control() interface makes a
|
|
direct call to the xFileControl method for the sqlite3_io_methods
|
|
object associated with a particular database identified by the second
|
|
argument.
|
|
The name of the database is "main" for the main database or "temp"
|
|
for the TEMP database, or the name that appears after the AS keyword
|
|
for databases that are added using the ATTACH SQL command.
|
|
A NULL pointer can be used in place of "main" to refer to the main
|
|
database file.
|
|
The third and fourth parameters to this routine are passed directly
|
|
through to the second and third parameters of the xFileControl method.
|
|
The return value of the xFileControl method becomes the return value
|
|
of this routine.
|
|
.Pp
|
|
The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes a pointer
|
|
to the underlying sqlite3_file object to be written into
|
|
the space pointed to by the 4th parameter.
|
|
The SQLITE_FCNTL_FILE_POINTER case is a short-circuit path which does
|
|
not actually invoke the underlying sqlite3_io_methods.xFileControl
|
|
method.
|
|
.Pp
|
|
If the second parameter (zDbName) does not match the name of any open
|
|
database file, then SQLITE_ERROR is returned.
|
|
This error code is not remembered and will not be recalled by sqlite3_errcode()
|
|
or sqlite3_errmsg().
|
|
The underlying xFileControl method might also return SQLITE_ERROR.
|
|
There is no way to distinguish between an incorrect zDbName and an
|
|
SQLITE_ERROR return from the underlying xFileControl method.
|
|
.Pp
|
|
.Sh SEE ALSO
|
|
.Xr sqlite3_errcode 3 ,
|
|
.Xr sqlite3_file 3 ,
|
|
.Xr sqlite3_file_control 3 ,
|
|
.Xr sqlite3_io_methods 3 ,
|
|
.Xr SQLITE_FCNTL_LOCKSTATE 3
|