Virtual Method

EDataServerClientretrieve_capabilities_sync

deprecated: 3.8 since: 3.2

Declaration [src]

gboolean
retrieve_capabilities_sync (
  EClient* client,
  gchar** capabilities,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Initiates retrieval of capabilities on the client. This is usually required only once, after the client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. Returned value of capabilities should be freed with g_free(), when no longer needed.

Available since: 3.2

Deprecated since: 3.8

Use e_client_get_capabilities() instead.

Parameters

capabilities

Type: gchar**

Comma-separated list of capabilities of the client.

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.
The value is a NUL terminated UTF-8 string.
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 virtual function 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.