sqlite3_config(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
SQLITE3_CONFIG(3)       NetBSD Library Functions Manual      SQLITE3_CONFIG(3)


NAME

     sqlite3_config -- configuring the SQLite library


SYNOPSIS

     #include <sqlite3.h>

     int
     sqlite3_config(int, ...);


DESCRIPTION

     The sqlite3_config() interface is used to make global configuration
     changes to SQLite in order to tune SQLite to the specific needs of the
     application.  The default configuration is recommended for most applica-
     tions and so this routine is usually not necessary.  It is provided to
     support rare applications with unusual needs.

     The sqlite3_config() interface is not threadsafe.  The application must
     ensure that no other SQLite interfaces are invoked by other threads while
     sqlite3_config() is running.

     The first argument to sqlite3_config() is an integer configuration option
     that determines what property of SQLite is to be configured.  Subsequent
     arguments vary depending on the configuration option in the first argu-
     ment.

     For most configuration options, the sqlite3_config() interface may only
     be invoked prior to library initialization using sqlite3_initialize() or
     after shutdown by sqlite3_shutdown().  The exceptional configuration
     options that may be invoked at any time are called "anytime configuration
     options".  If sqlite3_config() is called after sqlite3_initialize() and
     before sqlite3_shutdown() with a first argument that is not an anytime
     configuration option, then the sqlite3_config() call will return
     SQLITE_MISUSE.  Note, however, that sqlite3_config() can be called as
     part of the implementation of an application-defined sqlite3_os_init().
     When a configuration option is set, sqlite3_config() returns SQLITE_OK.
     If the option is unknown or SQLite is unable to set the option then this
     routine returns a non-zero error code.


IMPLEMENTATION NOTES

     These declarations were extracted from the interface documentation at
     line 1647.

     SQLITE_API int sqlite3_config(int, ...);


SEE ALSO

     sqlite3_initialize(3), SQLITE_CONFIG_SINGLETHREAD(3), SQLITE_OK(3)

NetBSD 10.99                   January 24, 2024                   NetBSD 10.99