Method

EDataCalCalCacheget_component

since: 3.26

Declaration [src]

gboolean
e_cal_cache_get_component (
  ECalCache* cal_cache,
  const gchar* uid,
  const gchar* rid,
  ECalComponent** out_component,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Gets a component identified by uid, and optionally by the rid, from the cal_cache. The returned out_component should be freed with g_object_unref(), when no longer needed.

Available since: 3.26

Parameters

uid

Type: const gchar*

A UID of the component.

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.

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

Type: ECalComponent

Return location for an ECalComponent.

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.
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.