Obtains the name of a column. (UTF-8 version.)
Parameters
MimerStatement statementhandle,
int16_t column,
char *columnname,
size_t maxsiz)
statementhandle |
in |
A handle returned by MimerBeginStatement[C|8], identifying a prepared statement. |
column |
in |
The column number, where the leftmost column is 1. |
columnname |
out |
The are where to return the column name. The maximum column name length returned is maxsiz-1. |
maxsiz |
in |
The size of the columnname area. |
Returns
Returns the size of the column name in bytes. If this value is larger than maxsiz-1, a truncation occurred. If a negative value was returned, there was an error.
Return value |
Description |
---|---|
>= 0 |
Length of column name (in characters) |
MIMER_HANDLE_INVALID |
The statementhandle parameter was not recognized as a handle. |
MIMER_SEQUENCE_ERROR |
Statement is not compiled. |
MIMER_NONEXISTENT_COLUMN_PARAMETER |
The column number does not exist. |
Other value < 0 |
Any of the server error codes listed in Return Codes. |
Notes
Not Micro API compatible.
UTF-8 version of the routine. See Character String Formats for more information about character formats and the different routine versions.