Method

EDataBookBookCacheremove_contact

since: 3.26

Declaration [src]

gboolean
e_book_cache_remove_contact (
  EBookCache* book_cache,
  const gchar* uid,
  guint32 custom_flags,
  ECacheOfflineFlag offline_flag,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Removes the contact identified by uid from book_cache.

Available since: 3.26

Parameters

uid

Type: const gchar*

The uid of the contact to remove.

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

Type: guint32

Custom flags for the contact with the given uid, not interpreted by the book_cache.

offline_flag

Type: ECacheOfflineFlag

One of ECacheOfflineFlag, whether removing this contact 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.