__iew_get_cursor() – Get cursor value

A cursor contains the item number at which binder should begin processing. It is also updated at the end of a retrieval request so that it acts as a placeholder when all the selected data does not fit in the buffer provided. The cursor value is initially set to zero to tell the binder to begin with the first item.

The __iew_get_cursor() function returns the cursor value that is stored in a private data associated with the returned buffer from the previous API call.

Format

#include <__iew_api.h>
int __iew_get_cursor(_IEWAPIContext *__context, 
                                   void **__data_entry,
                                   const char *__class,
                                   int *__cursor);

Parameters Descriptions

__context: API context is created and returned by calling __iew_openW() and is used throughout the open session.
__data_entry: returned buffer – based on class name.
__class: class name (binder-defined class).
__cursor: starting position

Returned Value

If successful, __iew_get_cursor() returns 0.

If unsuccessful, __iew_get_cursor() returns nonzero.