SQLITE3_VALUE_SUBTYPE(3)

SQLITE3_VALUE_SUBTYPE(3) | Library Functions Manual | SQLITE3_VALUE_SUBTYPE(3)

# NAME

`sqlite3_value_subtype` — finding the subtype of SQL values

# SYNOPSIS

`#include <sqlite3.h>`

unsigned int
`sqlite3_value_subtype`(sqlite3_value*);

# DESCRIPTION

The sqlite3_value_subtype(V) function returns the subtype for an application-defined SQL function argument V. The subtype information can be used to pass a limited amount of context from one SQL function to another. Use the `sqlite3_result_subtype`() routine to set the subtype for the return value of an SQL function.

Every application-defined SQL function that invoke this interface should include the SQLITE_SUBTYPE property in the text encoding argument when the function is registered. If the SQLITE_SUBTYPE property is omitted, then sqlite3_value_subtype() might return zero instead of the upstream subtype in some corner cases.

# IMPLEMENTATION NOTES

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

    SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);

# SEE ALSO

sqlite3_create_function(3), sqlite3_result_subtype(3), SQLITE_DETERMINISTIC(3)

January 24, 2024 | NetBSD 11.0