1.Dd December 19, 2018 2.Dt SQLITE3_STR_ERRCODE 3 3.Os 4.Sh NAME 5.Nm sqlite3_str_errcode , 6.Nm sqlite3_str_length , 7.Nm sqlite3_str_value 8.Nd Status Of A Dynamic String 9.Sh SYNOPSIS 10.Ft int 11.Fo sqlite3_str_errcode 12.Fa "sqlite3_str*" 13.Fc 14.Ft int 15.Fo sqlite3_str_length 16.Fa "sqlite3_str*" 17.Fc 18.Ft char * 19.Fo sqlite3_str_value 20.Fa "sqlite3_str*" 21.Fc 22.Sh DESCRIPTION 23These interfaces return the current status of an sqlite3_str 24object. 25.Pp 26If any prior errors have occurred while constructing the dynamic string 27in sqlite3_str X, then the sqlite3_str_errcode(X) 28method will return an appropriate error code. 29The sqlite3_str_errcode(X) method returns SQLITE_NOMEM 30following any out-of-memory error, or SQLITE_TOOBIG if 31the size of the dynamic string exceeds SQLITE_MAX_LENGTH, 32or SQLITE_OK if there have been no errors. 33.Pp 34The sqlite3_str_length(X) method returns the current 35length, in bytes, of the dynamic string under construction in sqlite3_str 36object X. 37The length returned by sqlite3_str_length(X) does 38not include the zero-termination byte. 39.Pp 40The sqlite3_str_value(X) method returns a pointer 41to the current content of the dynamic string under construction in 42X. 43The value returned by sqlite3_str_value(X) is managed 44by the sqlite3_str object X and might be freed or altered by any subsequent 45method on the same sqlite3_str object. 46Applications must not used the pointer returned sqlite3_str_value(X) 47after any subsequent method call on the same object. 48Applications may change the content of the string returned by sqlite3_str_value(X) 49as long as they do not write into any bytes outside the range of 0 50to sqlite3_str_length(X) and do not read or write 51any byte after any subsequent sqlite3_str method call. 52.Sh SEE ALSO 53.Xr sqlite3_str 3 , 54.Xr SQLITE_OK 3 55