summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:48:15 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:25 +0200
commita606d5219eab7a063758dea80359ce3cbc7a60f0 (patch)
tree7799fb9513ab72df5d864cf58db9493bab5e4fe5 /lib
parent0ab8a8e5bace6a796ea1a8b5b8f30275f1ea27eb (diff)
downloadsamba-a606d5219eab7a063758dea80359ce3cbc7a60f0.tar.gz
samba-a606d5219eab7a063758dea80359ce3cbc7a60f0.tar.bz2
samba-a606d5219eab7a063758dea80359ce3cbc7a60f0.zip
libsmbconf: Document smbconf_set_global_includes().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib')
-rw-r--r--lib/smbconf/smbconf.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index bc1335eb25..10c7a78e32 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -397,6 +397,18 @@ sbcErr smbconf_set_includes(struct smbconf_ctx *ctx,
const char *service,
uint32_t num_includes, const char **includes);
+/**
+ * @brief Set a list of config files to include globally.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] num_includes The number of includes to set.
+ *
+ * @param[in] includes A list of paths to include.
+ *
+ * @return SBC_ERR_OK on success, a corresponding sbcErr if an
+ * error occured.
+ */
sbcErr smbconf_set_global_includes(struct smbconf_ctx *ctx,
uint32_t num_includes,
const char **includes);