Method

ECalClientget_object_list_as_comps_sync

since: 3.2

Declaration [src]

gboolean
e_cal_client_get_object_list_as_comps_sync (
  ECalClient* client,
  const gchar* sexp,
  GSList** out_ecalcomps,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Gets a list of objects from the calendar that match the query specified by the sexp argument. The objects will be returned in the out_ecalcomps argument, which is a list of ECalComponent. This list should be freed with e_client_util_free_object_slist().

Available since: 3.2

Parameters

sexp

Type: const gchar*

An S-expression representing the query.

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

Type: A list of None

List of matching ECalComponents.

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

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.