Add function for mapping NDR error codes to strings.
[Samba.git] / lib / smbconf / smbconf.h
blob106fae6431d7f7ab65f4a0edd741888dc2a1e13f
1 /*
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__
23 struct smbconf_ctx;
25 /* the change sequence number */
26 struct smbconf_csn {
27 uint64_t csn;
30 struct smbconf_service {
31 char *name;
32 uint32_t num_params;
33 char **param_names;
34 char **param_values;
38 * the smbconf API functions
40 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx);
41 bool smbconf_is_writeable(struct smbconf_ctx *ctx);
42 void smbconf_shutdown(struct smbconf_ctx *ctx);
43 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
44 const char *service, const char *param);
45 WERROR smbconf_drop(struct smbconf_ctx *ctx);
46 WERROR smbconf_get_config(struct smbconf_ctx *ctx,
47 TALLOC_CTX *mem_ctx,
48 uint32_t *num_shares,
49 struct smbconf_service ***services);
50 WERROR smbconf_get_share_names(struct smbconf_ctx *ctx,
51 TALLOC_CTX *mem_ctx,
52 uint32_t *num_shares,
53 char ***share_names);
54 bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
55 WERROR smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
56 WERROR smbconf_get_share(struct smbconf_ctx *ctx,
57 TALLOC_CTX *mem_ctx,
58 const char *servicename,
59 struct smbconf_service **service);
60 WERROR smbconf_delete_share(struct smbconf_ctx *ctx,
61 const char *servicename);
62 WERROR smbconf_set_parameter(struct smbconf_ctx *ctx,
63 const char *service,
64 const char *param,
65 const char *valstr);
66 WERROR smbconf_set_global_parameter(struct smbconf_ctx *ctx,
67 const char *param, const char *val);
68 WERROR smbconf_get_parameter(struct smbconf_ctx *ctx,
69 TALLOC_CTX *mem_ctx,
70 const char *service,
71 const char *param,
72 char **valstr);
73 WERROR smbconf_get_global_parameter(struct smbconf_ctx *ctx,
74 TALLOC_CTX *mem_ctx,
75 const char *param,
76 char **valstr);
77 WERROR smbconf_delete_parameter(struct smbconf_ctx *ctx,
78 const char *service, const char *param);
79 WERROR smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
80 const char *param);
81 WERROR smbconf_get_includes(struct smbconf_ctx *ctx,
82 TALLOC_CTX *mem_ctx,
83 const char *service,
84 uint32_t *num_includes, char ***includes);
85 WERROR smbconf_get_global_includes(struct smbconf_ctx *ctx,
86 TALLOC_CTX *mem_ctx,
87 uint32_t *num_includes, char ***includes);
88 WERROR smbconf_set_includes(struct smbconf_ctx *ctx,
89 const char *service,
90 uint32_t num_includes, const char **includes);
91 WERROR smbconf_set_global_includes(struct smbconf_ctx *ctx,
92 uint32_t num_includes,
93 const char **includes);
94 WERROR smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service);
95 WERROR smbconf_delete_global_includes(struct smbconf_ctx *ctx);
97 #endif /* _LIBSMBCONF_H_ */