5.2.22hdfql_cursor_next
Syntax
int hdfql_cursor_next(HDFQL_CURSOR *cursor)
Description
Move a cursor named cursor one position forward from its current position. In other words, the cursor will point to the next element of the result set, and its position is incremented by one. If the result set is empty or the cursor is in the last position, an error is returned, and its position remains unchanged (i.e. remains minus one) or is set to the value returned by hdfql_cursor_get_count, respectively.
Parameter(s)
cursor – pointer to a cursor to move one position forward from its current position. If the pointer is NULL (in C), the cursor in use is moved one position forward from its current position instead. The equivalent of a NULL pointer in C++, Java, Python, C#, Fortran, R, and MATLAB HDFql wrappers is NULL, null, None, null, NULL(), NULL, and NaN, respectively. While in C cursor is mandatory, in C++, Java, Python, C#, Fortran, R, and MATLAB it is optional (when not specified, the cursor in use is moved one position forward from its current position instead).
Return
int – depending on the success in moving the cursor one position forward from its current position, it can be HDFQL_SUCCESS, HDFQL_ERROR_EMPTY, or HDFQL_ERROR_AFTER_LAST.
Example(s)
// show (i.e. get) working directory currently in use
hdfql_execute("SHOW USE DIRECTORY");
// move the cursor in use to the next position within the result set
hdfql_cursor_next(NULL);
// display position of cursor within the result set (should be "Position of cursor is 0")
printf("Position of cursor is %lld\n", hdfql_cursor_get_position(NULL));