Returns the maximum number of bytes required to hold one row of data. This routine might be used to calculate the maximum number of rows allowed in an array fetching scenario under certain memory restrictions.
For example, if it was determined that the fetching buffer must use no more than 20 000 bytes, although it would be desirable to use array fetching for performance reasons, calling this function would obtain a value to divide 20 000 with obtaining a reasonable maximum array set size.
Parameters
int32_t MimerRowSize (MimerStatement statementhandle)
|
statementhandle |
in |
A handle returned by MimerBeginStatement[C|8], identifying the compiled statement which maximum row size to obtain. |
Returns
If positive, the minimum number of bytes required to be guaranteed to hold one row of data. If negative, an error condition.
|
Return value |
Description |
|---|---|
|
>= 0 |
Number of bytes required to hold one row of data. 0 means that no input data |
|
MIMER_HANDLE_INVALID |
The statementhandle parameter was not recognized as a handle. |
|
MIMER_SEQUENCE_ERROR |
Statement is not compiled. |
Notes
Not Micro API compatible.