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)
48 /* the change sequence number */
53 struct smbconf_service
{
61 * @brief Translate an error value into a string
65 * @return a pointer to a static string
67 const char *sbcErrorString(sbcErr error
);
70 * the smbconf API functions
72 bool smbconf_backend_requires_messaging(struct smbconf_ctx
*ctx
);
73 bool smbconf_is_writeable(struct smbconf_ctx
*ctx
);
74 void smbconf_shutdown(struct smbconf_ctx
*ctx
);
75 bool smbconf_changed(struct smbconf_ctx
*ctx
, struct smbconf_csn
*csn
,
76 const char *service
, const char *param
);
77 sbcErr
smbconf_drop(struct smbconf_ctx
*ctx
);
78 WERROR
smbconf_get_config(struct smbconf_ctx
*ctx
,
81 struct smbconf_service
***services
);
82 sbcErr
smbconf_get_share_names(struct smbconf_ctx
*ctx
,
86 bool smbconf_share_exists(struct smbconf_ctx
*ctx
, const char *servicename
);
87 sbcErr
smbconf_create_share(struct smbconf_ctx
*ctx
, const char *servicename
);
88 WERROR
smbconf_get_share(struct smbconf_ctx
*ctx
,
90 const char *servicename
,
91 struct smbconf_service
**service
);
92 WERROR
smbconf_delete_share(struct smbconf_ctx
*ctx
,
93 const char *servicename
);
94 WERROR
smbconf_set_parameter(struct smbconf_ctx
*ctx
,
98 WERROR
smbconf_set_global_parameter(struct smbconf_ctx
*ctx
,
99 const char *param
, const char *val
);
100 WERROR
smbconf_get_parameter(struct smbconf_ctx
*ctx
,
105 WERROR
smbconf_get_global_parameter(struct smbconf_ctx
*ctx
,
109 WERROR
smbconf_delete_parameter(struct smbconf_ctx
*ctx
,
110 const char *service
, const char *param
);
111 WERROR
smbconf_delete_global_parameter(struct smbconf_ctx
*ctx
,
113 WERROR
smbconf_get_includes(struct smbconf_ctx
*ctx
,
116 uint32_t *num_includes
, char ***includes
);
117 WERROR
smbconf_get_global_includes(struct smbconf_ctx
*ctx
,
119 uint32_t *num_includes
, char ***includes
);
120 WERROR
smbconf_set_includes(struct smbconf_ctx
*ctx
,
122 uint32_t num_includes
, const char **includes
);
123 WERROR
smbconf_set_global_includes(struct smbconf_ctx
*ctx
,
124 uint32_t num_includes
,
125 const char **includes
);
126 WERROR
smbconf_delete_includes(struct smbconf_ctx
*ctx
, const char *service
);
127 WERROR
smbconf_delete_global_includes(struct smbconf_ctx
*ctx
);
129 WERROR
smbconf_transaction_start(struct smbconf_ctx
*ctx
);
130 WERROR
smbconf_transaction_commit(struct smbconf_ctx
*ctx
);
131 WERROR
smbconf_transaction_cancel(struct smbconf_ctx
*ctx
);
133 #endif /* _LIBSMBCONF_H_ */