KIM Preferences Documentation

Functions

Function Documentation

kim_error_t kim_preferences_create (  kim_preferences_t *  out_preferences  ) 
 

Create a new preferences object from the current user's preferences.

Parameters:
out_preferences on exit, a new preferences object. Must be freed with kim_preferences_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_preferences_copy (  kim_preferences_t *  out_preferences,
kim_preferences_t  in_preferences
) 
 

Copy a preferences object.

Parameters:
out_preferences on exit, a new preferences object which is a copy of in_preferences. Must be freed with kim_favorite_identities_free().
in_preferences a preferences object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_preferences_set_options (  kim_preferences_t  io_preferences,
kim_options_t  in_options
) 
 

Set the user's preferred options.

Parameters:
io_preferences a preferences object to modify.
in_options an options object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_options()

kim_error_t kim_preferences_get_options (  kim_preferences_t  in_preferences,
kim_options_t *  out_options
) 
 

Get the user's preferred options.

Parameters:
in_preferences a preferences object.
out_options on exit, the options specified in in_preferences. Must be freed with kim_options_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_options()

kim_error_t kim_preferences_set_remember_options (  kim_preferences_t  io_preferences,
kim_boolean_t  in_remember_options
) 
 

Set whether or not to remember the last options the user used to acquire a credential.

Parameters:
io_preferences a preferences object to modify.
in_remember_options a boolean value indicating whether or not to remember the last options used to acquire a credential.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_remember_options()

kim_error_t kim_preferences_get_remember_options (  kim_preferences_t  in_preferences,
kim_boolean_t *  out_remember_options
) 
 

Get whether or not to remember the last options the user used to acquire a credential.

Parameters:
in_preferences a preferences object.
out_remember_options on exit, a boolean value indicating whether or in_preferences will remember the last options used to acquire a credential.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_remember_options()

kim_error_t kim_preferences_set_client_identity (  kim_preferences_t  io_preferences,
kim_identity_t  in_client_identity
) 
 

Set the user's preferred client identity.

Parameters:
io_preferences a preferences object to modify.
in_client_identity a client identity object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_client_identity()

kim_error_t kim_preferences_get_client_identity (  kim_preferences_t  in_preferences,
kim_identity_t *  out_client_identity
) 
 

Get the user's preferred client identity.

Parameters:
in_preferences a preferences object.
out_client_identity on exit, the client identity specified in in_preferences. Must be freed with kim_identity_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_client_identity()

kim_error_t kim_preferences_set_remember_client_identity (  kim_preferences_t  io_preferences,
kim_boolean_t  in_remember_client_identity
) 
 

Set whether or not to remember the last client identity the user acquired a credential for.

Parameters:
io_preferences a preferences object to modify.
in_remember_client_identity a boolean value indicating whether or not to remember the last client identity for which a credential was acquired.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_remember_client_identity()

kim_error_t kim_preferences_get_remember_client_identity (  kim_preferences_t  in_preferences,
kim_boolean_t *  out_remember_client_identity
) 
 

Get whether or not to remember the last client identity the user acquired a credential for.

Parameters:
in_preferences a preferences object.
out_remember_client_identity on exit, a boolean value indicating whether or in_preferences will remember the last client identity for which a credential was acquired.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_remember_client_identity()

kim_error_t kim_preferences_set_minimum_lifetime (  kim_preferences_t  io_preferences,
kim_lifetime_t  in_minimum_lifetime
) 
 

Set the minimum credential lifetime for GUI credential lifetime controls.

Parameters:
io_preferences a preferences object to modify.
in_minimum_lifetime a minimum lifetime indicating how small a lifetime the GUI tools should allow the user to specify for credentials.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_minimum_lifetime()

kim_error_t kim_preferences_get_minimum_lifetime (  kim_preferences_t  in_preferences,
kim_lifetime_t *  out_minimum_lifetime
) 
 

Get the minimum credential lifetime for GUI credential lifetime controls.

Parameters:
in_preferences a preferences object.
out_minimum_lifetime on exit, the minimum lifetime that GUI tools will allow the user to specify for credentials.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_minimum_lifetime()

kim_error_t kim_preferences_set_maximum_lifetime (  kim_preferences_t  io_preferences,
kim_lifetime_t  in_maximum_lifetime
) 
 

Set the maximum credential lifetime for GUI credential lifetime controls.

Parameters:
io_preferences a preferences object to modify.
in_maximum_lifetime a maximum lifetime indicating how large a lifetime the GUI tools should allow the user to specify for credentials.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_maximum_lifetime()

kim_error_t kim_preferences_get_maximum_lifetime (  kim_preferences_t  in_preferences,
kim_lifetime_t *  out_maximum_lifetime
) 
 

Get the maximum credential lifetime for GUI credential lifetime controls.

Parameters:
in_preferences a preferences object.
out_maximum_lifetime on exit, the maximum lifetime that GUI tools will allow the user to specify for credentials.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_maximum_lifetime()

kim_error_t kim_preferences_set_minimum_renewal_lifetime (  kim_preferences_t  io_preferences,
kim_lifetime_t  in_minimum_renewal_lifetime
) 
 

Set the minimum credential renewal lifetime for GUI credential lifetime controls.

Parameters:
io_preferences a preferences object to modify.
in_minimum_renewal_lifetime a minimum lifetime indicating how small a lifetime the GUI tools should allow the user to specify for credential renewal.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_minimum_renewal_lifetime()

kim_error_t kim_preferences_get_minimum_renewal_lifetime (  kim_preferences_t  in_preferences,
kim_lifetime_t *  out_minimum_renewal_lifetime
) 
 

Get the minimum credential renewal lifetime for GUI credential lifetime controls.

Parameters:
in_preferences a preferences object.
out_minimum_renewal_lifetime on exit, the minimum lifetime that GUI tools will allow the user to specify for credential renewal.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_minimum_renewal_lifetime()

kim_error_t kim_preferences_set_maximum_renewal_lifetime (  kim_preferences_t  io_preferences,
kim_lifetime_t  in_maximum_renewal_lifetime
) 
 

Set the maximum credential renewal lifetime for GUI credential lifetime controls.

Parameters:
io_preferences a preferences object to modify.
in_maximum_renewal_lifetime a maximum lifetime indicating how large a lifetime the GUI tools should allow the user to specify for credential renewal.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_minimum_renewal_lifetime()

kim_error_t kim_preferences_get_maximum_renewal_lifetime (  kim_preferences_t  in_preferences,
kim_lifetime_t *  out_maximum_renewal_lifetime
) 
 

Get the maximum credential renewal lifetime for GUI credential lifetime controls.

Parameters:
in_preferences a preferences object.
out_maximum_renewal_lifetime on exit, the maximum lifetime that GUI tools will allow the user to specify for credential renewal.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_minimum_renewal_lifetime()

kim_error_t kim_preferences_set_favorite_identities (  kim_preferences_t  io_preferences,
kim_favorite_identities_t  in_favorite_identities
) 
 

Set the user's preferred list of identities.

Parameters:
io_preferences a preferences object to modify.
in_favorite_identities a favorite identities object. See KIM Favorite Identities Overview for more information on KIM Favorite Identities.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_get_favorite_identities()

kim_error_t kim_preferences_get_favorite_identities (  kim_preferences_t  in_preferences,
kim_favorite_identities_t *  out_favorite_identities
) 
 

Get the user's preferred list of identities.

Parameters:
in_preferences a preferences object.
out_favorite_identities on exit, a copy of the favorite identities specified in in_preferences. See KIM Favorite Identities Overview for more information on KIM Favorite Identities. Must be freed with kim_favorite_identities_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.
See also:
kim_preferences_set_favorite_identities()

kim_error_t kim_preferences_synchronize (  kim_preferences_t  in_preferences  ) 
 

Synchronize a preferences object with the user's preferences, writing pending changes and reading any changes applied by other processes.

Parameters:
in_preferences a preferences object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

void kim_preferences_free (  kim_preferences_t *  io_preferences  ) 
 

Free memory associated with a preferences object.

Parameters:
io_preferences the preferences object to be freed. Set to NULL on exit.