Method

EBookBookClientremove_contacts_sync

since: 3.2

Declaration [src]

gboolean
e_book_client_remove_contacts_sync (
  EBookClient* client,
  const GSList* uids,
  guint32 opflags,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Removes the contacts with uids from the list uids from client. This is always more efficient than calling e_book_client_remove_contact() if you have more than one uid to remove, as some backends can implement it as a batch request.

Available since: 3.2

Parameters

uids

Type: A list of utf8

A GSList of UIDs to remove.

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

Type: EBookOperationFlags

Bit-or of EBookOperationFlags.

cancellable

Type: GCancellable

A GCancellable; can be 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 if successful, FALSE otherwise.