Using SQLite

Name

sqlite3_create_function() — Define a scalar or aggregate SQL function

Definition

int sqlite3_create_function(   sqlite3* db, const char* name, int num_param,
        int text_rep, void* udp, func_func, step_func, final_func );
int sqlite3_create_function16( sqlite3* db, const void* name, int num_param,
        int text_rep, void* udp, func_func, step_func, final_func );

void func_func(  sqlite3_context* ctx, int argc, sqlite3_value** argv );
void step_func(  sqlite3_context* ctx, int argc, sqlite3_value** argv );
void final_func( sqlite3_context* ctx );

db

A database connection.

name

The name of the collation in UTF-8 or UTF-16, depending on the function used.

num_param

The number of expected parameters in the SQL function. If the value is ‒1, any number of parameters will be accepted.

text_rep

The text representation best suited to the function(s). This value can be one of SQLITE_UTF8, SQLITE_UTF16 (native order), SQLITE_UTF16BE, SQLITE_UTF16LE, or SQLITE_ ANY.

udp

An application-defined user-data pointer. This value can be extracted from the ctx parameter using the sqlite3_user_data() function.

func_func

A function pointer to an application-defined scalar SQL function implementation. If this is non-NULL, the step_func and final_func parameters must be NULL.

step_func

A function pointer to an application-defined aggregate step function implementation. If this is non-NULL, the func_func parameter must be NULL and the final_func parameter must be non-NULL.

final_func

A function pointer to an application-defined ...