[BACK]Return to sqlite3_db_status.3 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / external / public-domain / sqlite / man
File: [cvs.NetBSD.org] / src / external / public-domain / sqlite / man / sqlite3_db_status.3 (download)

Revision 1.4, Sat Mar 11 16:29:52 2017 UTC (7 years, 1 month ago) by christos
Branch: MAIN
CVS Tags: prg-localcount2-base3, prg-localcount2-base2, prg-localcount2-base1, prg-localcount2-base, prg-localcount2, phil-wifi-base, pgoyette-localcount-20170426, pgoyette-localcount-20170320, pgoyette-compat-base, pgoyette-compat-1126, pgoyette-compat-1020, pgoyette-compat-0930, pgoyette-compat-0906, pgoyette-compat-0728, pgoyette-compat-0625, pgoyette-compat-0521, pgoyette-compat-0502, pgoyette-compat-0422, pgoyette-compat-0415, pgoyette-compat-0407, pgoyette-compat-0330, pgoyette-compat-0322, pgoyette-compat-0315, perseant-stdc-iso10646-base, perseant-stdc-iso10646, netbsd-8-base, netbsd-8-2-RELEASE, netbsd-8-1-RELEASE, netbsd-8-1-RC1, netbsd-8-0-RELEASE, netbsd-8-0-RC2, netbsd-8-0-RC1, netbsd-8, matt-nb8-mediatek-base, matt-nb8-mediatek, bouyer-socketcan-base1
Branch point for: phil-wifi, pgoyette-compat
Changes since 1.3: +2 -2 lines 

merge 3.17.0

.Dd March 11, 2017
.Dt SQLITE3_DB_STATUS 3
.Os
.Sh NAME
.Nm sqlite3_db_status
.Nd Database Connection Status
.Sh SYNOPSIS
.Ft int 
.Fo sqlite3_db_status
.Fa "sqlite3*"
.Fa "int op"
.Fa "int *pCur"
.Fa "int *pHiwtr"
.Fa "int resetFlg"
.Fc
.Sh DESCRIPTION
This interface is used to retrieve runtime status information about
a single database connection.
The first argument is the database connection object to be interrogated.
The second argument is an integer constant, taken from the set of SQLITE_DBSTATUS options,
that determines the parameter to interrogate.
The set of SQLITE_DBSTATUS options is likely
to grow in future releases of SQLite.
.Pp
The current value of the requested parameter is written into *pCur
and the highest instantaneous value is written into *pHiwtr.
If the resetFlg is true, then the highest instantaneous value is reset
back down to the current value.
.Pp
The sqlite3_db_status() routine returns SQLITE_OK on success and a
non-zero error code on failure.
.Pp
.Sh SEE ALSO
.Xr sqlite3 3 ,
.Xr sqlite3_status 3 ,
.Xr sqlite3_stmt_status 3 ,
.Xr SQLITE_DBSTATUS_LOOKASIDE_USED 3