summaryrefslogtreecommitdiffstats
path: root/src/include
diff options
context:
space:
mode:
authorZhanna Tsitkov <tsitkova@mit.edu>2011-03-29 16:22:05 +0000
committerZhanna Tsitkov <tsitkova@mit.edu>2011-03-29 16:22:05 +0000
commit54a459f0c28587fe8ebd83c22830ac786386f3d7 (patch)
treefb1a7a80e7b6f837ba2250f2bce335c071048451 /src/include
parenta3c90d3f23e13dad1605c11b62c9d0c2205f2270 (diff)
downloadkrb5-54a459f0c28587fe8ebd83c22830ac786386f3d7.tar.gz
krb5-54a459f0c28587fe8ebd83c22830ac786386f3d7.tar.xz
krb5-54a459f0c28587fe8ebd83c22830ac786386f3d7.zip
If the new configuration data that is passed to krb5_cc_set_config is NULL, just remove the old configuration.
Moved short krb5_cc_set_config usage example from krb5.hin into the separate file. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24753 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src/include')
-rw-r--r--src/include/krb5/krb5.hin17
1 files changed, 5 insertions, 12 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 977977e87a..0e7fd3fe5d 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -4024,21 +4024,14 @@ krb5_cc_get_config(krb5_context context, krb5_ccache id,
/** Store some configuration for the credential cache in the cache.
*
- * @param context a Keberos context [input,output]
- * @param id the credential cache to store the data for. [input]
- * @param principal configuration for a specific principal; if NULL, global for the whole cache.[input]
- * @param key name under which the configuraion is stored.[input]
- * @param data data to store. [input]
+ * @param [in,out] context a Keberos context
+ * @param [in] id the credential cache to store the data for.
+ * @param [in] principal configuration for a specific principal; if NULL, global for the whole cache.
+ * @param [in] key name under which the configuraion is stored.
+ * @param [in] data data to store. If NULL, old configuration is removed.
*
* @note Existing configuration under the same key is over-written.
*
- * @code
- * Example:
- * config_data.data = "yes";
- * config_data.length = strlen(config_data.data);
- * krb5_cc_set_config(context, id, principal,key, &config_data);
- * @endcode
- *
* @retval
* 0 Success
* @return