Method

SecretRetrievableretrieve_secret_sync

since: 0.19.0

Declaration [src]

SecretValue*
secret_retrievable_retrieve_secret_sync (
  SecretRetrievable* self,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Retrieve the secret value of this object synchronously.

Each retrievable object has a single secret which might be a password or some other secret binary value.

This method may block indefinitely and should not be used in user interface threads.

Available since: 0.19.0

Parameters

cancellable

Type: GCancellable

Optional cancellation object.

The argument can be NULL.

The data is owned by the caller of the function.

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 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: SecretValue

The secret value which should be released with secret_value_unref(), or NULL.

The caller of the method takes ownership of the data, and is responsible for freeing it.

The return value can be NULL.