diff options
| author | Alexandra Ellwood <lxs@mit.edu> | 2008-10-09 17:51:03 +0000 |
|---|---|---|
| committer | Alexandra Ellwood <lxs@mit.edu> | 2008-10-09 17:51:03 +0000 |
| commit | a963958bb2579862a367b6523a3f46d53109f8c8 (patch) | |
| tree | 993ffc9f6175c99fd467a0cbf95548cda16f4d91 /src/include/kim | |
| parent | 599a2fa44ec8d00eb632d6063220b43fb2455a52 (diff) | |
| download | krb5-a963958bb2579862a367b6523a3f46d53109f8c8.tar.gz krb5-a963958bb2579862a367b6523a3f46d53109f8c8.tar.xz krb5-a963958bb2579862a367b6523a3f46d53109f8c8.zip | |
preferences should handle KIM_OPTIONS_DEFAULT
ticket: new
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@20854 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src/include/kim')
| -rw-r--r-- | src/include/kim/kim_options.h | 3 | ||||
| -rw-r--r-- | src/include/kim/kim_preferences.h | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/src/include/kim/kim_options.h b/src/include/kim/kim_options.h index 2c82b3ef5..d36aa0c02 100644 --- a/src/include/kim/kim_options.h +++ b/src/include/kim/kim_options.h @@ -185,7 +185,8 @@ kim_error kim_options_create (kim_options *out_options); /*! * \param out_options on exit, a new options object which is a copy of \a in_options. - * Must be freed with kim_options_free(). + * Must be freed with kim_options_free(). If passed KIM_OPTIONS_DEFAULT + * will set \a out_options to KIM_OPTIONS_DEFAULT. * \param in_options a options object. * \return On success, #KIM_NO_ERROR. On failure, an error code representing the failure. * \brief Copy options. diff --git a/src/include/kim/kim_preferences.h b/src/include/kim/kim_preferences.h index bce010cdd..d7970ba04 100644 --- a/src/include/kim/kim_preferences.h +++ b/src/include/kim/kim_preferences.h @@ -177,7 +177,8 @@ kim_error kim_preferences_set_options (kim_preferences io_preferences, /*! * \param in_preferences a preferences object. * \param out_options on exit, the options specified in \a in_preferences. - * Must be freed with kim_options_free(). + * May be KIM_OPTIONS_DEFAULT. + * If not, must be freed with kim_options_free(). * \return On success, #KIM_NO_ERROR. On failure, an error code representing the failure. * \brief Get the user's preferred options. * \sa kim_preferences_set_options() |