get_cursor_sync


Description:

[ Version ( since = "3.12" ) ]
public bool get_cursor_sync (string sexp, ContactField sort_fields, BookCursorSortType sort_types, uint n_fields, out BookClientCursor out_cursor, Cancellable? cancellable = null) throws Error

Create an BookClientCursor.

If successful, then the out_cursor is set to newly allocated BookClientCursor, the cursor should be freed with unref when no longer needed.

Note: sexp can be obtained through BookQuery, by converting it to a string with to_string.

Parameters:

this

an BookClient

sexp

an S-expression representing the query

sort_fields

an array of ContactFields to sort the cursor with

sort_types

an array of BookCursorSortTypes to complement sort_fields

n_fields

the length of the input sort_fields and sort_types arrays

out_cursor

return location for an BookClientCursor

cancellable

a Cancellable; can be null

Returns:

true if successful, false otherwise.