Method

EDataCalCalCacheremove_component

since: 3.26

Declaration [src]

gboolean
e_cal_cache_remove_component (
  ECalCache* cal_cache,
  const gchar* uid,
  const gchar* rid,
  guint32 custom_flags,
  ECacheOfflineFlag offline_flag,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Removes a component identified by uid and rid from the cal_cache. When the rid is NULL, or an empty string, then removes the master object only, without any detached instance.

Available since: 3.26

Parameters

uid

Type: const gchar*

A UID of the component 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*

An optional Recurrence-ID 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.
custom_flags

Type: guint32

Custom flags for the component, not interpreted by the cal_cache.

offline_flag

Type: ECacheOfflineFlag

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

Whether succeeded.