Method

EDataBookBookBackendSyncremove_contacts

since: 3.34

Declaration [src]

gboolean
e_book_backend_sync_remove_contacts (
  EBookBackendSync* backend,
  const gchar* const* uids,
  guint32 opflags,
  GSList** out_removed_uids,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Removes one or more contacts according to uids.

If an error occurs, the function will set error and return FALSE.

Available since: 3.34

Parameters

uids

Type: const gchar* const*

A NULL-terminated array of contact ID strings.

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

Type: guint32

Bit-or of EBookOperationFlags.

out_removed_uids

Type: A list of utf8

A GSList of removed UIDs.

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.
Each element is a NUL terminated UTF-8 string.
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, FALSE on failure.