Method

CamelStoreSearchget_items_sync

unstable since: 3.58

Declaration [src]

gboolean
camel_store_search_get_items_sync (
  CamelStoreSearch* self,
  GPtrArray** out_items,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Reads all the items from all the set folders satisfying the set expression.

Free the out_items array with g_ptr_array_unref(), when no longer needed.

Available since: 3.58

Parameters

out_items

Type: An array of None

An output argument for the CamelStoreSearchItem items.

The argument will be set by the function.
The caller of the method takes ownership of the returned data container, but not the data inside it.
cancellable

Type: GCancellable

A GCancellable, 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.