xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_version.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE3_VERSION 3
3.Os
4.Sh NAME
5.Nm sqlite3_version ,
6.Nm sqlite3_libversion ,
7.Nm sqlite3_sourceid ,
8.Nm sqlite3_libversion_number
9.Nd Run-Time Library Version Numbers
10.Sh SYNOPSIS
11.Vt const char sqlite3_version[];
12.Ft const char *
13.Fo sqlite3_libversion
14.Fa "void"
15.Fc
16.Ft const char *
17.Fo sqlite3_sourceid
18.Fa "void"
19.Fc
20.Ft int
21.Fo sqlite3_libversion_number
22.Fa "void"
23.Fc
24.Sh DESCRIPTION
25These interfaces provide the same information as the SQLITE_VERSION,
26SQLITE_VERSION_NUMBER, and SQLITE_SOURCE_ID
27C preprocessor macros but are associated with the library instead of
28the header file.
29Cautious programmers might include assert() statements in their application
30to verify that values returned by these interfaces match the macros
31in the header, and thus ensure that the application is compiled with
32matching library and header files.
33.Bd -ragged
34.Bd -literal
35assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); assert(
36strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0
37);
38.Ed
39.Pp
40.Ed
41.Pp
42The sqlite3_version[] string constant contains the text of SQLITE_VERSION
43macro.
44The sqlite3_libversion() function returns a pointer to the to the sqlite3_version[]
45string constant.
46The sqlite3_libversion() function is provided for use in DLLs since
47DLL users usually do not have direct access to string constants within
48the DLL.
49The sqlite3_libversion_number() function returns an integer equal to
50SQLITE_VERSION_NUMBER.
51The sqlite3_sourceid() function returns a pointer to a string constant
52whose value is the same as the SQLITE_SOURCE_ID C preprocessor
53macro.
54.Pp
55.Sh SEE ALSO
56.Xr SQLITE_VERSION 3
57