diff options
| author | Andreas Schneider <asn@samba.org> | 2011-04-14 11:02:49 +0200 |
|---|---|---|
| committer | Michael Adam <obnox@samba.org> | 2011-05-10 19:13:23 +0200 |
| commit | 7a57ccd2c5d64680bf6386d8fa0c1443819a6f42 (patch) | |
| tree | db290525e22a786ba058f244ddc0f12ceab34c74 /lib/smbconf/smbconf.h | |
| parent | c31fd2b22aa42feb8557353a8d1bd2697f4a8eee (diff) | |
| download | samba-7a57ccd2c5d64680bf6386d8fa0c1443819a6f42.tar.gz samba-7a57ccd2c5d64680bf6386d8fa0c1443819a6f42.tar.xz samba-7a57ccd2c5d64680bf6386d8fa0c1443819a6f42.zip | |
libsmbconf: Document smbconf_backend_requires_messaging().
Signed-off-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'lib/smbconf/smbconf.h')
| -rw-r--r-- | lib/smbconf/smbconf.h | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 467b5caa79..8e3b40b7a1 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -58,6 +58,10 @@ struct smbconf_service { char **param_values; }; +/* + * The smbconf API functions + */ + /** * @brief Translate an error value into a string * @@ -67,10 +71,18 @@ struct smbconf_service { **/ const char *sbcErrorString(sbcErr error); -/* - * the smbconf API functions +/** + * @brief Check if the backend requires messaging to be set up. + * + * Tell whether the backend requires messaging to be set up + * for the backend to work correctly. + * + * @param[in] ctx The smbconf context to check. + * + * @return True if needed, false if not. */ bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx); + bool smbconf_is_writeable(struct smbconf_ctx *ctx); void smbconf_shutdown(struct smbconf_ctx *ctx); bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn, |