diff options
Diffstat (limited to 'static/netbsd/man3/sqlite3_trace_v2.3')
| -rw-r--r-- | static/netbsd/man3/sqlite3_trace_v2.3 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_trace_v2.3 b/static/netbsd/man3/sqlite3_trace_v2.3 new file mode 100644 index 00000000..4c5d5940 --- /dev/null +++ b/static/netbsd/man3/sqlite3_trace_v2.3 @@ -0,0 +1,62 @@ +.Dd January 24, 2024 +.Dt SQLITE3_TRACE_V2 3 +.Os +.Sh NAME +.Nm sqlite3_trace_v2 +.Nd SQL trace hook +.Sh SYNOPSIS +.In sqlite3.h +.Ft int +.Fo sqlite3_trace_v2 +.Fa "sqlite3*" +.Fa "unsigned uMask" +.Fa "int(*xCallback)(unsigned,void*,void*,void*)" +.Fa "void *pCtx" +.Fc +.Sh DESCRIPTION +The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback +function X against database connection D, using +property mask M and context pointer P. +If the X callback is NULL or if the M mask is zero, then tracing is +disabled. +The M argument should be the bitwise OR-ed combination of zero or more +SQLITE_TRACE constants. +.Pp +Each call to either sqlite3_trace(D,X,P) or sqlite3_trace_v2(D,M,X,P) +overrides (cancels) all prior calls to sqlite3_trace(D,X,P) or sqlite3_trace_v2(D,M,X,P) +for the database connection D. +Each database connection may have at most one trace callback. +.Pp +The X callback is invoked whenever any of the events identified by +mask M occur. +The integer return value from the callback is currently ignored, though +this may change in future releases. +Callback implementations should return zero to ensure future compatibility. +.Pp +A trace callback is invoked with four arguments: callback(T,C,P,X). +The T argument is one of the SQLITE_TRACE constants to +indicate why the callback was invoked. +The C argument is a copy of the context pointer. +The P and X arguments are pointers whose meanings depend on T. +.Pp +The sqlite3_trace_v2() interface is intended to replace the legacy +interfaces +.Fn sqlite3_trace +and +.Fn sqlite3_profile , +both of which are deprecated. +.Sh IMPLEMENTATION NOTES +These declarations were extracted from the +interface documentation at line 3383. +.Bd -literal +SQLITE_API int sqlite3_trace_v2( + sqlite3*, + unsigned uMask, + int(*xCallback)(unsigned,void*,void*,void*), + void *pCtx +); +.Ed +.Sh SEE ALSO +.Xr sqlite3 3 , +.Xr sqlite3_trace 3 , +.Xr SQLITE_TRACE_STMT 3 |
