summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:44:22 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:25 +0200
commit74dc8c351c33a3b73251985ffa3b19ec024bcfc9 (patch)
tree38d3eaffc501132aae53330ebb4ab243c011fe3c
parentb7ba46d1c0e1fdd5b68dd0478d38a633938aae84 (diff)
downloadsamba-74dc8c351c33a3b73251985ffa3b19ec024bcfc9.tar.gz
samba-74dc8c351c33a3b73251985ffa3b19ec024bcfc9.tar.bz2
samba-74dc8c351c33a3b73251985ffa3b19ec024bcfc9.zip
libsmbconf: Document smbconf_get_includes().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r--lib/smbconf/smbconf.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 49f1b70aa2..4d511a08aa 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -340,10 +340,27 @@ sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx,
sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
const char *param);
+/**
+ * @brief Get the list of names of included files.
+ *
+ * @param[in] ctx The smbconf context to use.
+ *
+ * @param[in] mem_ctx The memory context to allocate the names.
+ *
+ * @param[in] service The service name to get the include files.
+ *
+ * @param[out] num_includes A pointer to store the number of included files.
+ *
+ * @param[out] includes A pointer to store the paths of the included files.
+ *
+ * @return SBC_ERR_OK on success, a corresponding sbcErr if an
+ * error occured.
+ */
sbcErr smbconf_get_includes(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
const char *service,
uint32_t *num_includes, char ***includes);
+
sbcErr smbconf_get_global_includes(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,
uint32_t *num_includes, char ***includes);