xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_stmt_isexplain.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_STMT_ISEXPLAIN 3
3.Os
4.Sh NAME
5.Nm sqlite3_stmt_isexplain
6.Nd query the EXPLAIN setting for a prepared statement
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_stmt_isexplain
11.Fa "sqlite3_stmt *pStmt"
12.Fc
13.Sh DESCRIPTION
14The sqlite3_stmt_isexplain(S) interface returns 1 if the prepared statement
15S is an EXPLAIN statement, or 2 if the statement S is an EXPLAIN QUERY
16PLAN.
17The sqlite3_stmt_isexplain(S) interface returns 0 if S is an ordinary
18statement or a NULL pointer.
19.Sh IMPLEMENTATION NOTES
20These declarations were extracted from the
21interface documentation at line 4417.
22.Bd -literal
23SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);
24.Ed
25