diff options
| author | Andreas Schneider <asn@samba.org> | 2011-04-14 11:36:36 +0200 |
|---|---|---|
| committer | Karolin Seeger <kseeger@samba.org> | 2011-05-15 20:20:16 +0200 |
| commit | 99e019cfa1f451659d12ca83ece49b45c7776304 (patch) | |
| tree | d6305b8c0e407d8056337fd1278191e42c91a206 /lib | |
| parent | a315cc58e03ee95c70a84adc8e21aa35966957e7 (diff) | |
| download | samba-99e019cfa1f451659d12ca83ece49b45c7776304.tar.gz samba-99e019cfa1f451659d12ca83ece49b45c7776304.tar.xz samba-99e019cfa1f451659d12ca83ece49b45c7776304.zip | |
libsmbconf: Document smbconf_get_global_parameter().
Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit 247ad89ee50fd2205cc02eb2f7d8902c1b75a7ad)
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/smbconf/smbconf.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 83f62746ec0..fb3e027107b 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -289,10 +289,27 @@ sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx, const char *param, char **valstr); +/** + * @brief Get the value of a global configuration parameter as a string. + * + * It also creates [global] if it does't exist. + * + * @param[in] ctx The smbconf context to use. + * + * @param[in] mem_ctx The memory context to allocate the string on. + * + * @param[in] param The parameter to get. + * + * @param[out] valstr A pointer to store the value as a string. + * + * @return SBC_ERR_OK on success, a corresponding sbcErr if an + * error occured. + */ sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx, TALLOC_CTX *mem_ctx, const char *param, char **valstr); + sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx, const char *service, const char *param); sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx, |