Method

EDataServerSourceremote_delete_sync

since: 3.6

Declaration [src]

gboolean
e_source_remote_delete_sync (
  ESource* source,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Deletes the resource represented by source from a remote server. The source must be ESource:remote-deletable. This will also delete the key file for source and broadcast its removal to all clients, similar to e_source_remove_sync().

If an error occurs, the function will set error and return FALSE.

Available since: 3.6

Parameters

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

TRUE on success, FALSE on error.