diff options
author | Andreas Schneider <asn@samba.org> | 2011-04-14 11:37:59 +0200 |
---|---|---|
committer | Michael Adam <obnox@samba.org> | 2011-05-10 19:13:24 +0200 |
commit | d70acdc554d6bbab367d7e0ebb0a255f528b94ed (patch) | |
tree | 7f5e210539e183f5b6193b6c4b30bb57d4e6647c /lib | |
parent | 1cb649f57f2a53b2e0067c1a9dd26dca8fdaf850 (diff) | |
download | samba-d70acdc554d6bbab367d7e0ebb0a255f528b94ed.tar.gz samba-d70acdc554d6bbab367d7e0ebb0a255f528b94ed.tar.bz2 samba-d70acdc554d6bbab367d7e0ebb0a255f528b94ed.zip |
libsmbconf: Document smbconf_delete_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/smbconf/smbconf.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index fb3e027107..9bb911dc58 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -310,8 +310,21 @@ sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx, const char *param, char **valstr); +/** + * @brief Delete a parameter from the configuration. + * + * @param[in] ctx The smbconf context to use. + * + * @param[in] service The service where the parameter can be found. + * + * @param[in] param The name of the parameter to delete. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx, const char *service, const char *param); + sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx, const char *param); sbcErr smbconf_get_includes(struct smbconf_ctx *ctx, |