SQLITE3_STR_ERRCODE(3)

SQLITE3_STR_ERRCODE(3) | Library Functions Manual | SQLITE3_STR_ERRCODE(3)

# NAME

`sqlite3_str_errcode`, `sqlite3_str_length`, `sqlite3_str_value` — status of a dynamic string

# SYNOPSIS

`#include <sqlite3.h>`

int
`sqlite3_str_errcode`(sqlite3_str*);

int
`sqlite3_str_length`(sqlite3_str*);

char *
`sqlite3_str_value`(sqlite3_str*);

# DESCRIPTION

These interfaces return the current status of an sqlite3_str object.

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

The sqlite3_str_length(X) method returns the current length, in bytes, of the dynamic string under construction in sqlite3_str object X. The length returned by sqlite3_str_length(X) does not include the zero-termination byte.

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

# IMPLEMENTATION NOTES

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

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

# SEE ALSO

sqlite3_str(3), SQLITE_OK(3)

January 24, 2024 | NetBSD 11.0