get_contact_list


Description:

[ Version ( since = "3.34" ) ]
public bool get_contact_list (string query, out SList<Contact> out_contacts, Cancellable? cancellable = null) throws Error

Obtains a set of Contact instances which satisfy the criteria specified in query, and deposits them in out_contacts.

The returned Contact instances are referenced for thread-safety and must be unreferenced with unref when finished with them.

If an error occurs, the function will set throws and return false. Note that an empty result set does not necessarily imply an error.

Parameters:

this

an BookBackendSync

query

a search query in S-expression format

out_contacts

a SList in which to deposit results

cancellable

optional Cancellable object, or null

Returns:

true on success, false on failure