xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_compileoption_used.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE3_COMPILEOPTION_USED 3
3.Os
4.Sh NAME
5.Nm sqlite3_compileoption_used ,
6.Nm sqlite3_compileoption_get
7.Nd Run-Time Library Compilation Options Diagnostics
8.Sh SYNOPSIS
9.Ft int
10.Fo sqlite3_compileoption_used
11.Fa "const char *zOptName"
12.Fc
13.Ft const char *
14.Fo sqlite3_compileoption_get
15.Fa "int N"
16.Fc
17.Sh DESCRIPTION
18The sqlite3_compileoption_used() function returns 0 or 1 indicating
19whether the specified option was defined at compile time.
20The SQLITE_ prefix may be omitted from the option name passed to sqlite3_compileoption_used().
21.Pp
22The sqlite3_compileoption_get() function allows iterating over the
23list of options that were defined at compile time by returning the
24N-th compile time option string.
25If N is out of range, sqlite3_compileoption_get() returns a NULL pointer.
26The SQLITE_ prefix is omitted from any strings returned by sqlite3_compileoption_get().
27.Pp
28Support for the diagnostic functions sqlite3_compileoption_used() and
29sqlite3_compileoption_get() may be omitted by specifying the SQLITE_OMIT_COMPILEOPTION_DIAGS
30option at compile time.
31.Pp
32