Method

EDataBookBookSqlitesearch_uids

since: 3.12

Declaration [src]

gboolean
e_book_sqlite_search_uids (
  EBookSqlite* ebsql,
  const gchar* sexp,
  GSList** ret_list,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Similar to e_book_sqlitedb_search(), but fetches only a list of contact UIDs.

The returned ret_list list should be freed with g_slist_free() and all elements freed with g_free().

Available since: 3.12

Parameters

sexp

Type: const gchar*

Search expression; use NULL or an empty string to get all stored contacts.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
ret_list

Type: A list of utf8

Return location to store a GSList of contact uids.

The argument will be set by the function.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.
Each element is a NUL terminated UTF-8 string.
cancellable

Type: GCancellable

A GCancellable.

The argument can be NULL.
The data is owned by the caller of the method.
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 a NULL GError*.
The argument will be left initialized to NULL by the method 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.

Return value

Type: gboolean

TRUE on success, otherwise FALSE is returned and error is set appropriately.