xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_context.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_CONTEXT 3
3.Os
4.Sh NAME
5.Nm sqlite3_context
6.Nd SQL function context object
7.Sh SYNOPSIS
8.In sqlite3.h
9.Vt typedef struct sqlite3_context sqlite3_context;
10.Sh DESCRIPTION
11The context in which an SQL function executes is stored in an sqlite3_context
12object.
13A pointer to an sqlite3_context object is always first parameter to
14application-defined SQL functions.
15The application-defined SQL function implementation will pass this
16pointer through into calls to sqlite3_result(),
17.Fn sqlite3_aggregate_context ,
18.Fn sqlite3_user_data ,
19.Fn sqlite3_context_db_handle ,
20.Fn sqlite3_get_auxdata ,
21and/or
22.Fn sqlite3_set_auxdata .
23.Sh IMPLEMENTATION NOTES
24These declarations were extracted from the
25interface documentation at line 4529.
26.Bd -literal
27typedef struct sqlite3_context sqlite3_context;
28.Ed
29.Sh SEE ALSO
30.Xr sqlite3_aggregate_context 3 ,
31.Xr sqlite3_context_db_handle 3 ,
32.Xr sqlite3_get_auxdata 3 ,
33.Xr sqlite3_result_blob 3 ,
34.Xr sqlite3_user_data 3
35