Result Codes

Result Codes — Mate Keyring Result Codes

Synopsis

const gchar*        mate_keyring_result_to_message     (MateKeyringResult res);
enum                MateKeyringResult;

Description

Result codes used through out MATE Keyring. Additional result codes may be added from time to time and these should be handled gracefully.

Details

mate_keyring_result_to_message ()

const gchar*        mate_keyring_result_to_message     (MateKeyringResult res);

The MATE_KEYRING_RESULT_OK and MATE_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 MateKeyringResult

Returns :

a string suitable for display to the user for a given MateKeyringResult, or an empty string if the message wouldn't make sense to a user.

enum MateKeyringResult

typedef enum {
	MATE_KEYRING_RESULT_OK,
	MATE_KEYRING_RESULT_DENIED,
	MATE_KEYRING_RESULT_NO_KEYRING_DAEMON,
	MATE_KEYRING_RESULT_ALREADY_UNLOCKED,
	MATE_KEYRING_RESULT_NO_SUCH_KEYRING,
	MATE_KEYRING_RESULT_BAD_ARGUMENTS,
	MATE_KEYRING_RESULT_IO_ERROR,
	MATE_KEYRING_RESULT_CANCELLED,
	MATE_KEYRING_RESULT_KEYRING_ALREADY_EXISTS,
	MATE_KEYRING_RESULT_NO_MATCH
} MateKeyringResult;