Release alpha15.
[nivanova/samba-autobuild/.git] / source3 / rpc_client / cli_winreg_int.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *
4  *  WINREG internal client routines
5  *
6  *  Copyright (c) 2011      Andreas Schneider <asn@samba.org>
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 3 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifndef CLI_WINREG_INT_H
23 #define CLI_WINREG_INT_H
24
25 struct auth_serversupplied_info;
26
27 /**
28  * @brief Connect to the interal winreg server and open the given key.
29  *
30  * The function will create the needed subkeys if they don't exist.
31  *
32  * @param[in]  mem_ctx       The memory context to use.
33  *
34  * @param[in]  session_info   The supplied server info.
35  *
36  * @param[in]  key           The key to open. This needs to start with the name
37  *                           of the hive like HKLM.
38  *
39  * @param[in]  create_key    Set to true if the key should be created if it
40  *                           doesn't exist.
41  *
42  * @param[in]  access_mask   The access mask to open the key.
43  *
44  * @param[out] binding_handle A pointer for the winreg dcerpc binding handle.
45  *
46  * @param[out] hive_handle   A policy handle for the opened hive.
47  *
48  * @param[out] key_handle    A policy handle for the opened key.
49  *
50  * @return                   WERR_OK on success, the corresponding DOS error
51  *                           code if something gone wrong.
52  */
53 NTSTATUS dcerpc_winreg_int_openkey(TALLOC_CTX *mem_ctx,
54                                    const struct auth_serversupplied_info *server_info,
55                                    struct messaging_context *msg_ctx,
56                                    struct dcerpc_binding_handle **h,
57                                    const char *key,
58                                    bool create_key,
59                                    uint32_t access_mask,
60                                    struct policy_handle *hive_handle,
61                                    struct policy_handle *key_handle,
62                                    WERROR *pwerr);
63
64 /**
65  * @brief Connect to the interal winreg server and open the given key.
66  *
67  * The function will create the needed subkeys if they don't exist.
68  *
69  * @param[in]  mem_ctx       The memory context to use.
70  *
71  * @param[in]  server_info   The supplied server info.
72  *
73  * @param[in]  key           The key to open.
74  *
75  * @param[in]  create_key    Set to true if the key should be created if it
76  *                           doesn't exist.
77  *
78  * @param[in]  access_mask   The access mask to open the key.
79  *
80  * @param[out] binding_handle A pointer for the winreg dcerpc binding handle.
81  *
82  * @param[out] hive_handle   A policy handle for the opened hive.
83  *
84  * @param[out] key_handle    A policy handle for the opened key.
85  *
86  * @return                   WERR_OK on success, the corresponding DOS error
87  *                           code if something gone wrong.
88  */
89 NTSTATUS dcerpc_winreg_int_hklm_openkey(TALLOC_CTX *mem_ctx,
90                                         const struct auth_serversupplied_info *session_info,
91                                         struct messaging_context *msg_ctx,
92                                         struct dcerpc_binding_handle **h,
93                                         const char *key,
94                                         bool create_key,
95                                         uint32_t access_mask,
96                                         struct policy_handle *hive_handle,
97                                         struct policy_handle *key_handle,
98                                         WERROR *pwerr);
99
100 #endif /* CLI_WINREG_INT_H */
101
102 /* vim: set ts=8 sw=8 noet cindent syntax=c.doxygen: */