WHATSNEW: Start release notes for 3.6.0pre3.
[Samba.git] / source3 / rpc_client / cli_winreg_int.h
blobf175c17f5c90364ae7b15455f2f0c196a53e3281
1 /*
2 * Unix SMB/CIFS implementation.
4 * WINREG internal client routines
6 * Copyright (c) 2011 Andreas Schneider <asn@samba.org>
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.
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.
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/>.
22 #ifndef CLI_WINREG_INT_H
23 #define CLI_WINREG_INT_H
25 struct auth_serversupplied_info;
27 /**
28 * @brief Connect to the interal winreg server and open the given key.
30 * The function will create the needed subkeys if they don't exist.
32 * @param[in] mem_ctx The memory context to use.
34 * @param[in] session_info The supplied server info.
36 * @param[in] key The key to open. This needs to start with the name
37 * of the hive like HKLM.
39 * @param[in] create_key Set to true if the key should be created if it
40 * doesn't exist.
42 * @param[in] access_mask The access mask to open the key.
44 * @param[out] binding_handle A pointer for the winreg dcerpc binding handle.
46 * @param[out] hive_handle A policy handle for the opened hive.
48 * @param[out] key_handle A policy handle for the opened key.
50 * @return WERR_OK on success, the corresponding DOS error
51 * code if something gone wrong.
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);
64 /**
65 * @brief Connect to the interal winreg server and open the given key.
67 * The function will create the needed subkeys if they don't exist.
69 * @param[in] mem_ctx The memory context to use.
71 * @param[in] server_info The supplied server info.
73 * @param[in] key The key to open.
75 * @param[in] create_key Set to true if the key should be created if it
76 * doesn't exist.
78 * @param[in] access_mask The access mask to open the key.
80 * @param[out] binding_handle A pointer for the winreg dcerpc binding handle.
82 * @param[out] hive_handle A policy handle for the opened hive.
84 * @param[out] key_handle A policy handle for the opened key.
86 * @return WERR_OK on success, the corresponding DOS error
87 * code if something gone wrong.
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);
100 #endif /* CLI_WINREG_INT_H */
102 /* vim: set ts=8 sw=8 noet cindent syntax=c.doxygen: */