Method

EDataBookBookCacheremove_contacts

since: 3.26

Declaration [src]

gboolean
e_book_cache_remove_contacts (
  EBookCache* book_cache,
  const GSList* uids,
  const GSList* custom_flags,
  ECacheOfflineFlag offline_flag,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Removes the contacts indicated by uids from book_cache. The custom_flags is used, if not NULL, only if the offline_flag is E_CACHE_IS_OFFLINE. Otherwise it’s ignored. The length of the custom_flags should match the length of uids, when not NULL.

Available since: 3.26

Parameters

uids

Type: A list of utf8

A GSList of uids indicating which contacts to remove.

The data is owned by the caller of the method.
Each element is a NUL terminated UTF-8 string.
custom_flags

Type: A list of guint32

An optional GSList of custom flags for the ids.

The argument can be NULL.
The data is owned by the caller of the method.
offline_flag

Type: ECacheOfflineFlag

One of ECacheOfflineFlag, whether removing these contacts in offline.

cancellable

Type: GCancellable

Optional GCancellable object, or NULL.

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.