Obtains the name of a parameter. (UTF-8 version.)
Parameters
MimerStatement statementhandle,
int16_t parameter,
char *parametername,
size_t maxsize)
statementhandle |
in |
A handle returned by MimerBeginStatement[C|8], identifying the compiled statement which parameters to count. |
parameter |
in |
The parameter number, where the leftmost parameter is 1. |
parametername |
out |
The area where to return the parameter name. The maximum parameter name length returned is maxsize-1. |
maxsize |
in |
The length of the parametername area in bytes, including room for terminating null. |
Returns
Returns the number of bytes in the parameter name. If this value is larger than maxsize-1, a truncation occurred. If a negative value was returned, there was an error.
Return value |
Description |
---|---|
> = 0 |
Number of bytes in parameter name. |
MIMER_HANDLE_INVALID |
The statementhandle parameter was not recognized as a handle. |
MIMER_SEQUENCE_ERROR |
The statement is not compiled. |
MIMER_NONEXISTENT_COLUMN_PARAMETER |
The parameter 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.