2 * Unix SMB/CIFS implementation.
3 * libsmbconf - Samba configuration library
4 * Copyright (C) Michael Adam 2008
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #ifndef __LIBSMBCONF_H__
21 #define __LIBSMBCONF_H__
24 * @brief Status codes returned from smbconf functions
27 SBC_ERR_OK = 0, /**< Successful completion **/
28 SBC_ERR_NOT_IMPLEMENTED, /**< Function not implemented **/
29 SBC_ERR_NOT_SUPPORTED, /**< Function not supported **/
30 SBC_ERR_UNKNOWN_FAILURE, /**< General failure **/
31 SBC_ERR_NOMEM, /**< Memory allocation error **/
32 SBC_ERR_INVALID_PARAM, /**< An Invalid parameter was supplied **/
33 SBC_ERR_BADFILE, /**< A bad file was supplied **/
34 SBC_ERR_NO_SUCH_SERVICE, /**< There is no such service provided **/
35 SBC_ERR_IO_FAILURE, /**< There was an IO error **/
36 SBC_ERR_CAN_NOT_COMPLETE,/**< Can not complete action **/
37 SBC_ERR_NO_MORE_ITEMS, /**< No more items left **/
38 SBC_ERR_FILE_EXISTS, /**< File already exists **/
39 SBC_ERR_ACCESS_DENIED, /**< Access has been denied **/
42 typedef enum _sbcErrType sbcErr;
44 #define SBC_ERROR_IS_OK(x) ((x) == SBC_ERR_OK)
45 #define SBC_ERROR_EQUAL(x,y) ((x) == (y))
49 /* the change sequence number */
54 struct smbconf_service {
62 * The smbconf API functions
66 * @brief Translate an error value into a string
70 * @return a pointer to a static string
72 const char *sbcErrorString(sbcErr error);
75 * @brief Check if the backend requires messaging to be set up.
77 * Tell whether the backend requires messaging to be set up
78 * for the backend to work correctly.
80 * @param[in] ctx The smbconf context to check.
82 * @return True if needed, false if not.
84 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx);
87 * @brief Tell whether the source is writeable.
89 * @param[in] ctx The smbconf context to check.
91 * @return True if it is writeable, false if not.
93 bool smbconf_is_writeable(struct smbconf_ctx *ctx);
95 void smbconf_shutdown(struct smbconf_ctx *ctx);
96 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
97 const char *service, const char *param);
98 sbcErr smbconf_drop(struct smbconf_ctx *ctx);
99 sbcErr smbconf_get_config(struct smbconf_ctx *ctx,
101 uint32_t *num_shares,
102 struct smbconf_service ***services);
103 sbcErr smbconf_get_share_names(struct smbconf_ctx *ctx,
105 uint32_t *num_shares,
106 char ***share_names);
107 bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
108 sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
109 sbcErr smbconf_get_share(struct smbconf_ctx *ctx,
111 const char *servicename,
112 struct smbconf_service **service);
113 sbcErr smbconf_delete_share(struct smbconf_ctx *ctx,
114 const char *servicename);
115 sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx,
119 sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx,
120 const char *param, const char *val);
121 sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx,
126 sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx,
130 sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx,
131 const char *service, const char *param);
132 sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
134 sbcErr smbconf_get_includes(struct smbconf_ctx *ctx,
137 uint32_t *num_includes, char ***includes);
138 sbcErr smbconf_get_global_includes(struct smbconf_ctx *ctx,
140 uint32_t *num_includes, char ***includes);
141 sbcErr smbconf_set_includes(struct smbconf_ctx *ctx,
143 uint32_t num_includes, const char **includes);
144 sbcErr smbconf_set_global_includes(struct smbconf_ctx *ctx,
145 uint32_t num_includes,
146 const char **includes);
147 sbcErr smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service);
148 sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx);
150 sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx);
151 sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx);
152 sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx);
154 #endif /* _LIBSMBCONF_H_ */