Method

EDataServerSourceCredentialsProviderstore_sync

since: 3.16

Declaration [src]

gboolean
e_source_credentials_provider_store_sync (
  ESourceCredentialsProvider* provider,
  ESource* source,
  const ENamedParameters* credentials,
  gboolean permanently,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Stores the credentials for source. Note the actual stored values can differ for each storage. In other words, not all named parameters are stored for each source.

If an error occurs, the function sets error and returns FALSE.

Available since: 3.16

Parameters

source

Type: ESource

An ESource, to store credentials for.

The data is owned by the caller of the method.
credentials

Type: ENamedParameters

An ENamedParameters with credentials to store.

The data is owned by the caller of the method.
permanently

Type: gboolean

Store permanently or just for the session.

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.