Method

EDataBookBookSqlitesearch

since: 3.12

Declaration [src]

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

Description [src]

Searches ebsql for contacts matching the search expression indicated by sexp.

When sexp refers only to EContactFields configured in the summary of ebsql, the search should always be quick, when searching for other EContactFields a fallback will be used, possibly invoking any EbSqlVCardCallback which may have been passed to e_book_sqlite_new_full().

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

If meta_contact is specified, then shallow vcard representations will be created holding only the E_CONTACT_UID and E_CONTACT_REV fields.

Available since: 3.12

Parameters

sexp

Type: const gchar*

Search expression; use NULL or an empty string to list 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.
meta_contacts

Type: gboolean

Whether entire contacts are desired, or only the metadata.

ret_list

Type: A list of None

Return location to store a GSList of EbSqlSearchData structures.

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.
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.