summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-04-14 11:12:27 +0200
committerMichael Adam <obnox@samba.org>2011-05-10 19:13:23 +0200
commit1b0809bd7340b9b596dc3f5be159d79726fe98c6 (patch)
tree69171eeca367e9647f668915c77924122bda874b
parent5cd229ca5e7c2c227c565b53ad3e23ebde51d3b1 (diff)
downloadsamba-1b0809bd7340b9b596dc3f5be159d79726fe98c6.tar.gz
samba-1b0809bd7340b9b596dc3f5be159d79726fe98c6.tar.bz2
samba-1b0809bd7340b9b596dc3f5be159d79726fe98c6.zip
libsmbconf: Document smbconf_changed().
Signed-off-by: Michael Adam <obnox@samba.org>
-rw-r--r--lib/smbconf/smbconf.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index f3d5909998..5c0f84d172 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -99,8 +99,28 @@ bool smbconf_is_writeable(struct smbconf_ctx *ctx);
*/
void smbconf_shutdown(struct smbconf_ctx *ctx);
+/**
+ * @brief Detect changes in the configuration.
+ *
+ * Get the change sequence number of the given service/parameter. Service and
+ * parameter strings may be NULL.
+ *
+ * The given change sequence number (csn) struct is filled with the current
+ * csn. smbconf_changed() can also be used for initial retrieval of the csn.
+ *
+ * @param[in] ctx The smbconf context to check for changes.
+ *
+ * @param[inout] csn The smbconf csn to be filled.
+ *
+ * @param[in] service The service name to check or NULL.
+ *
+ * @param[in] param The param to check or NULL.
+ *
+ * @return True if it has been changed, false if not.
+ */
bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
const char *service, const char *param);
+
sbcErr smbconf_drop(struct smbconf_ctx *ctx);
sbcErr smbconf_get_config(struct smbconf_ctx *ctx,
TALLOC_CTX *mem_ctx,