xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_stmt_busy.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE3_STMT_BUSY 3
3.Os
4.Sh NAME
5.Nm sqlite3_stmt_busy
6.Nd Determine If A Prepared Statement Has Been Reset
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3_stmt_busy
10.Fa "sqlite3_stmt*"
11.Fc
12.Sh DESCRIPTION
13The sqlite3_stmt_busy(S) interface returns true (non-zero) if the prepared statement
14S has been stepped at least once using sqlite3_step(S)
15but has neither run to completion (returned SQLITE_DONE
16from sqlite3_step(S)) nor been reset using sqlite3_reset(S).
17The sqlite3_stmt_busy(S) interface returns false if S is a NULL pointer.
18If S is not a NULL pointer and is not a pointer to a valid prepared statement
19object, then the behavior is undefined and probably undesirable.
20.Pp
21This interface can be used in combination sqlite3_next_stmt()
22to locate all prepared statements associated with a database connection
23that are in need of being reset.
24This can be used, for example, in diagnostic routines to search for
25prepared statements that are holding a transaction open.
26.Sh SEE ALSO
27.Xr sqlite3_stmt 3 ,
28.Xr sqlite3_next_stmt 3 ,
29.Xr SQLITE_OK 3
30