Opens a cursor to be used when reading a result set.
Result sets are produced either by SELECT queries, or by calls to result set procedures.
All input parameters must be set prior to calling MimerOpenCursor, or else an error will occur.
If this routine returns successfully, the cursor is opened and positioned before the first row.
The first row can then be fetched by calling MimerFetch. After that column data may be retrieved using data output routines.
If the statement does not return a result set, this routine will return with a failure.
Parameters
int32_t MimerOpenCursor (MimerStatement statementhandle)
|
statementhandle |
in |
A handle returned by MimerBeginStatement[C|8], identifying a statement that have been executed. |
Returns
A negative value indicating an error, or zero if successful.
|
Return value |
Description |
|---|---|
|
MIMER_SUCCESS |
Success. |
|
MIMER_HANDLE_INVALID |
The statementhandle parameter was not recognized as a handle. |
|
MIMER_OUTOFMEMORY |
If not enough memory could be allocated. |
|
MIMER_SEQUENCE_ERROR |
If the statement cursor is already open. |
|
MIMER_UNSET_PARAMETER |
All parameters has not yet been set. |
Notes
Micro API compatible.