Method

EDataCalCalMetaBackendsearch_components_sync

since: 3.26

Declaration [src]

gboolean
e_cal_meta_backend_search_components_sync (
  ECalMetaBackend* meta_backend,
  const gchar* expr,
  GSList** out_components,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Searches meta_backend with given expression expr and returns found components as a GSList of ECalComponent out_components. Free the returned out_components with g_slist_free_full (components, g_object_unref); when no longer needed. When the expr is NULL, all objects are returned. To get iCal strings instead, call e_cal_meta_backend_search_sync().

It is optional to implement this virtual method by the descendant. The default implementation searches meta_backends cache. It’s also not required to be online for searching, thus meta_backend doesn’t ensure it.

Available since: 3.26

Parameters

expr

Type: const gchar*

A search expression, or NULL.

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_components

Type: A list of None

Return location for the found ECalComponent-s.

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.