xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_value_encoding.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_VALUE_ENCODING 3
3.Os
4.Sh NAME
5.Nm sqlite3_value_encoding
6.Nd report the internal text encoding state of an sqlite3_value object
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_value_encoding
11.Fa "sqlite3_value*"
12.Fc
13.Sh DESCRIPTION
14The sqlite3_value_encoding(X) interface returns one of SQLITE_UTF8,
15SQLITE_UTF16BE, or SQLITE_UTF16LE according
16to the current text encoding of the value X, assuming that X has type
17TEXT.
18If sqlite3_value_type(X) returns something other than SQLITE_TEXT,
19then the return value from sqlite3_value_encoding(X) is meaningless.
20Calls to sqlite3_value_text(X), sqlite3_value_text16(X),
21sqlite3_value_text16be(X), sqlite3_value_text16le(X),
22sqlite3_value_bytes(X), or sqlite3_value_bytes16(X)
23might change the encoding of the value X and thus change the return
24from subsequent calls to sqlite3_value_encoding(X).
25.Pp
26This routine is intended for used by applications that test and validate
27the SQLite implementation.
28This routine is inquiring about the opaque internal state of an sqlite3_value
29object.
30Ordinary applications should not need to know what the internal state
31of an sqlite3_value object is and hence should not need to use this
32interface.
33.Sh IMPLEMENTATION NOTES
34These declarations were extracted from the
35interface documentation at line 5773.
36.Bd -literal
37SQLITE_API int sqlite3_value_encoding(sqlite3_value*);
38.Ed
39.Sh SEE ALSO
40.Xr sqlite3_value 3 ,
41.Xr SQLITE_UTF8 3
42