Small. Fast. Reliable.
Choose any three.

SQLite C Interface

Status Of A Dynamic String

int sqlite3_str_errcode(sqlite3_str*);
int sqlite3_str_length(sqlite3_str*);
char *sqlite3_str_value(sqlite3_str*);

These interfaces return the current status of an sqlite3_str object.

R-08681-56652:[If any prior errors have occurred while constructing the dynamic string in sqlite3_str X, then the sqlite3_str_errcode(X) method will return an appropriate error code. ] R-39084-14613:[The sqlite3_str_errcode(X) method returns SQLITE_NOMEM following any out-of-memory error, or SQLITE_TOOBIG if the size of the dynamic string exceeds SQLITE_MAX_LENGTH, or SQLITE_OK if there have been no errors. ]

R-40490-08523:[The sqlite3_str_length(X) method returns the current length, in bytes, of the dynamic string under construction in sqlite3_str object X. ] R-01458-26582:[The length returned by sqlite3_str_length(X) does not include the zero-termination byte. ]

R-54219-22147:[The sqlite3_str_value(X) method returns a pointer to the current content of the dynamic string under construction in X. ] The value returned by sqlite3_str_value(X) is managed by the sqlite3_str object X and might be freed or altered by any subsequent method on the same sqlite3_str object. Applications must not used the pointer returned sqlite3_str_value(X) after any subsequent method call on the same object. R-63304-47938:[Applications may change the content of the string returned by sqlite3_str_value(X) as long as they do not write into any bytes outside the range of 0 to sqlite3_str_length(X) and do not read or write any byte after any subsequent sqlite3_str method call. ]

See also lists of Objects, Constants, and Functions.