sqlite3_trace_v2

Navigation

API > API/Plugins > API/Plugins/SQLiteCore > API/Plugins/SQLiteCore/sqlite

References

int sqlite3_trace_v2  
(  
    sqlite3 *,  
    unsigned uMask,  
    int(*)(unsigned, void *, void *, void *) xCallback,  
    void * pCtx  
)  
Copy full snippet

int sqlite3_trace_v2 (     sqlite3 *,     unsigned uMask,     int(*)(unsigned, void *, void *, void *) xCallback,     void * pCtx )

Remarks

CAPI3REF: SQL Trace Hook METHOD: sqlite3

^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.

^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().

^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.

^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.

The sqlite3_trace_v2() interface is intended to replace the legacy interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which are deprecated.