Gets character data from a result set or an output parameter into a multi byte character string, where the character set is UTF-8.
Only the SQL data types CHARACTER, CHARACTER VARYING, NATIONAL CHARACTER and NATIONAL CHARACTER VARYING may be retrieved using this function.
Parameters
MimerStatement statementhandle,
int16_t paramno_colno,
char *dest,
size_t dest_maxsiz)
|
statementhandle |
in |
A handle returned by MimerBeginStatement[C|8], identifying a statement that have been executed. |
|
paramno_colno |
in |
The parameter number or column number to get data from. First parameter/column is 1. |
|
dest |
out |
A memory location where to place UTF-8 character data. The character data is null terminated. If this is a null pointer, no data will be returned, but the length is still returned by the routine. |
|
dest_maxsiz |
in |
The length of the dest memory location in bytes. |
Returns
A negative value indicating an error, or a zero or positive value indicating the number of bytes in the column (not counting the terminating zero).
|
Return value |
Description |
|---|---|
|
>= 0 |
Success. The number of characters to be returned. (If > dest_maxlen, output data was truncated.) |
|
MIMER_CAST_VIOLATION |
If the output parameter or column was not of the CHARACTER, CHARACTER VARYING, NATIONAL CHARACTER or NATIONAL CHARACTER VARYING data types. |
|
MIMER_HANDLE_INVALID |
The statementhandle parameter was not recognized as a handle. |
|
MIMER_NONEXISTENT_COLUMN_PARAMETER |
The supplied column or parameter number did not exist. |
|
MIMER_PARAMETER_NOT_OUTPUT |
The referenced parameter is not an output or input/output parameter, which is required when calling a data output routine. |
|
MIMER_SEQUENCE_ERROR |
If the statement cursor is not open, or the current row is before the first row of the result set, or after the last row of the result set. |
|
MIMER_SQL_NULL_VALUE |
The column or output parameter contained the SQL null value. (This can also be detected using the MimerIsNull routine.) |
Notes
Micro API compatible.
UTF-8 version of the routine. See Character String Formats for more information about character formats and the different routine versions.