xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_compileoption_used.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_COMPILEOPTION_USED 3
3.Os
4.Sh NAME
5.Nm sqlite3_compileoption_used ,
6.Nm sqlite3_compileoption_get ,
7.Nm sqlite3_compileoption_used(X) ,
8.Nm sqlite3_compileoption_get(X)
9.Nd run-Time library compilation options diagnostics
10.Sh SYNOPSIS
11.In sqlite3.h
12.Ft int
13.Fo sqlite3_compileoption_used
14.Fa "const char *zOptName"
15.Fc
16.Ft const char *
17.Fo sqlite3_compileoption_get
18.Fa "int N"
19.Fc
20.Fd #define sqlite3_compileoption_used(X)
21.Fd #define sqlite3_compileoption_get(X)
22.Sh DESCRIPTION
23The sqlite3_compileoption_used() function returns 0 or 1 indicating
24whether the specified option was defined at compile time.
25The SQLITE_ prefix may be omitted from the option name passed to sqlite3_compileoption_used().
26.Pp
27The sqlite3_compileoption_get() function allows iterating over the
28list of options that were defined at compile time by returning the
29N-th compile time option string.
30If N is out of range, sqlite3_compileoption_get() returns a NULL pointer.
31The SQLITE_ prefix is omitted from any strings returned by sqlite3_compileoption_get().
32.Pp
33Support for the diagnostic functions sqlite3_compileoption_used() and
34sqlite3_compileoption_get() may be omitted by specifying the SQLITE_OMIT_COMPILEOPTION_DIAGS
35option at compile time.
36.Pp
37.Sh IMPLEMENTATION NOTES
38These declarations were extracted from the
39interface documentation at line 191.
40.Bd -literal
41#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
42SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
43SQLITE_API const char *sqlite3_compileoption_get(int N);
44#else
45# define sqlite3_compileoption_used(X) 0
46# define sqlite3_compileoption_get(X)  ((void*)0)
47#endif
48.Ed
49