Method

ECalClientremove_object_sync

since: 3.2

Declaration [src]

gboolean
e_cal_client_remove_object_sync (
  ECalClient* client,
  const gchar* uid,
  const gchar* rid,
  ECalObjModType mod,
  ECalOperationFlags opflags,
  GCancellable* cancellable,
  GError** error
)

Description [src]

This function allows the removal of instances of a recurrent appointment. By using a combination of the uid, rid and mod arguments, you can remove specific instances. If what you want is to remove all instances, use NULL rid and #E_CAL_OBJ_MOD_ALL for the mod.

Available since: 3.2

Parameters

uid

Type: const gchar*

UID of the object to remove.

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

Type: const gchar*

Recurrence ID of the specific recurrence to remove.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
mod

Type: ECalObjModType

Type of the removal.

opflags

Type: ECalOperationFlags

Bit-or of ECalOperationFlags.

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.