Function
EDataBookDataBookCursorStepFunc
since: 3.12
Declaration
gint
(* EDataBookCursorStepFunc) (
EDataBookCursor* cursor,
const gchar* revision_guard,
EBookCursorStepFlags flags,
EBookCursorOrigin origin,
gint count,
GSList** results,
GCancellable* cancellable,
GError** error
)
Description [src]
Method type for EDataBookCursorClass.step()
As all cursor methods may be called either by the addressbook service or directly by a client in Direct Read Access mode, it is important that the operation be an atomic transaction with the underlying database.
The revision_guard, if specified, will be set to the CLIENT_BACKEND_PROPERTY_REVISION
value at the time which the given client issued the call to move the cursor.
If the revision_guard provided by the client does not match the stored addressbook
revision, then an E_CLIENT_ERROR_OUT_OF_SYNC error should be set to indicate
that the revision was out of sync while attempting to move the cursor.
See e_data_book_cursor_step() for more details on the expected behaviour of this method.
Available since: 3.12
Parameters
cursor-
Type:
EDataBookCursorAn
EDataBookCursor.The data is owned by the caller of the function. revision_guard-
Type:
const gchar*The expected current addressbook revision, or
NULL.The argument can be NULL.The data is owned by the caller of the function. The value is a NUL terminated UTF-8 string. flags-
Type:
EBookCursorStepFlagsThe
EBookCursorStepFlagsfor this step. origin-
Type:
EBookCursorOriginThe
EBookCursorOriginfrom whence to step. count-
Type:
gintA positive or negative amount of contacts to try and fetch.
results-
Type: A list of
utf8A return location to store the results, or
NULLifE_BOOK_CURSOR_STEP_FETCHis not specified inflags.The argument will be set by the function. The argument can be set to NULLby the function.The caller of the function takes ownership of the returned data, and is responsible for freeing it. Each element is a NUL terminated UTF-8 string. cancellable-
Type:
GCancellableA
GCancellable.The argument can be NULL.The data is owned by the caller of the function. error-
Type:
GError **The return location for a recoverable error.
The argument can be NULL.If the return location is not NULL, then you must initialize it to aNULLGError*.The argument will be left initialized to NULLby the function if there are no errors.In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.