gnome-keyring-result

gnome-keyring-result — Result Codes

Synopsis




const gchar*        gnome_keyring_result_to_message     (GnomeKeyringResult res);
enum                GnomeKeyringResult;

Description

Result codes used through out GNOME Keyring.

Details

gnome_keyring_result_to_message ()

const gchar*        gnome_keyring_result_to_message     (GnomeKeyringResult res);

The GNOME_KEYRING_RESULT_OK and GNOME_KEYRING_RESULT_CANCELLED codes will return an empty string.

Note that there are some results for which the application will need to take appropriate action rather than just display an error message to the user.

res : A GnomeKeyringResult
Returns : a string suitable for display to the user for a given GnomeKeyringResult, or an empty string if the message wouldn't make sense to a user.

enum GnomeKeyringResult

typedef enum {
	GNOME_KEYRING_RESULT_OK,
	GNOME_KEYRING_RESULT_DENIED,
	GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON,
	GNOME_KEYRING_RESULT_ALREADY_UNLOCKED,
	GNOME_KEYRING_RESULT_NO_SUCH_KEYRING,
	GNOME_KEYRING_RESULT_BAD_ARGUMENTS,
	GNOME_KEYRING_RESULT_IO_ERROR,
	GNOME_KEYRING_RESULT_CANCELLED,
	GNOME_KEYRING_RESULT_KEYRING_ALREADY_EXISTS
} GnomeKeyringResult;

Results returned from various functions.

GNOME_KEYRING_RESULT_OK The operation completed successfully
GNOME_KEYRING_RESULT_DENIED The operation was denied by the user, or by an access control.
GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON The daemon is not running or couldn't be connected to.
GNOME_KEYRING_RESULT_ALREADY_UNLOCKED Unused
GNOME_KEYRING_RESULT_NO_SUCH_KEYRING The keyring does not exist with the given name.
GNOME_KEYRING_RESULT_BAD_ARGUMENTS Bad arguments were passed to a function.
GNOME_KEYRING_RESULT_IO_ERROR A problem occurred when communicating with the daemon.
GNOME_KEYRING_RESULT_CANCELLED The operation was cancelled with gnome_keyring_cancel_request().
GNOME_KEYRING_RESULT_KEYRING_ALREADY_EXISTS A keyring with that name already exist.