Fix various build warnings
[ira/wip.git] / source3 / librpc / idl / winreg.idl
1 /*
2   winreg interface definition
3 */
4
5 import "lsa.idl", "initshutdown.idl", "security.idl";
6
7
8   uuid("338cd001-2244-31f1-aaaa-900038001003"),
9   version(1.0),
10   endpoint("ncacn_np:[\\pipe\\winreg]","ncacn_ip_tcp:","ncalrpc:"),
11   pointer_default(unique),
12   helpstring("Remote Registry Service")
13 ] interface winreg
14 {
15         typedef bitmap security_secinfo security_secinfo;
16
17         typedef [bitmap32bit] bitmap {
18                 KEY_QUERY_VALUE                 = 0x00001,
19                 KEY_SET_VALUE                   = 0x00002,
20                 KEY_CREATE_SUB_KEY              = 0x00004,
21                 KEY_ENUMERATE_SUB_KEYS  = 0x00008,
22                 KEY_NOTIFY                              = 0x00010,
23                 KEY_CREATE_LINK                 = 0x00020,
24                 KEY_WOW64_64KEY                 = 0x00100,
25                 KEY_WOW64_32KEY                 = 0x00200
26         } winreg_AccessMask;
27
28         typedef [v1_enum] enum {
29                 REG_NONE                       = 0,
30                 REG_SZ                         = 1,
31                 REG_EXPAND_SZ                  = 2,
32                 REG_BINARY                     = 3,
33                 REG_DWORD                      = 4,
34                 REG_DWORD_BIG_ENDIAN           = 5,
35                 REG_LINK                       = 6,
36                 REG_MULTI_SZ                   = 7,
37                 REG_RESOURCE_LIST              = 8,
38                 REG_FULL_RESOURCE_DESCRIPTOR   = 9,
39                 REG_RESOURCE_REQUIREMENTS_LIST = 10,
40                 REG_QWORD                      = 11
41         } winreg_Type;
42
43         typedef [public,noejs] struct {
44                 [value(strlen_m_term(name)*2)] uint16 name_len;
45                 [value(strlen_m_term(name)*2)] uint16 name_size;
46                 [string,charset(UTF16)] uint16 *name;
47         } winreg_String;
48
49         /******************/
50         /* Function: 0x00 */
51         WERROR winreg_OpenHKCR(
52                 [in,unique] uint16 *system_name,
53                 [in]      winreg_AccessMask access_mask,
54                 [out,ref] policy_handle *handle
55         );
56
57         /******************/
58         /* Function: 0x01 */
59         WERROR winreg_OpenHKCU(
60                 [in,unique] uint16 *system_name,
61                 [in]      winreg_AccessMask access_mask,
62                 [out,ref] policy_handle *handle
63         );
64
65         /******************/
66         /* Function: 0x02 */
67         WERROR winreg_OpenHKLM(
68                 [in,unique] uint16 *system_name,
69                 [in]      winreg_AccessMask access_mask,
70                 [out,ref] policy_handle *handle
71         );
72
73         /******************/
74         /* Function: 0x03 */
75         WERROR winreg_OpenHKPD(
76                 [in,unique] uint16 *system_name,
77                 [in]      winreg_AccessMask access_mask,
78                 [out,ref] policy_handle *handle
79         );
80
81         /******************/
82         /* Function: 0x04 */
83         WERROR winreg_OpenHKU(
84                 [in,unique] uint16 *system_name,
85                 [in]      winreg_AccessMask access_mask,
86                 [out,ref] policy_handle *handle
87         );
88
89         /******************/
90         /* Function: 0x05 */
91         WERROR winreg_CloseKey(
92                 [in,out,ref] policy_handle *handle
93         );
94
95         /******************/
96         /* Function: 0x06 */
97
98         typedef struct {
99                 [size_is(size),length_is(len)] uint8 *data;
100                 uint32 size;
101                 uint32 len;
102         } KeySecurityData;
103
104         typedef struct {
105                 uint32 length;
106                 KeySecurityData sd;
107                 boolean8  inherit;
108         } winreg_SecBuf;
109
110         typedef [v1_enum] enum {
111                 REG_ACTION_NONE         = 0, /* used by caller */
112                 REG_CREATED_NEW_KEY     = 1,
113                 REG_OPENED_EXISTING_KEY = 2
114         } winreg_CreateAction;
115
116         WERROR winreg_CreateKey(
117                 [in,ref] policy_handle *handle,
118                 [in] winreg_String name,
119                 [in] winreg_String keyclass,
120                 [in] uint32 options,
121                 [in] winreg_AccessMask access_mask,
122                 [in,unique] winreg_SecBuf *secdesc,
123                 [out,ref] policy_handle *new_handle,
124                 [in,out,unique] winreg_CreateAction *action_taken
125         );
126
127         /******************/
128         /* Function: 0x07 */
129         WERROR winreg_DeleteKey(
130                 [in,ref] policy_handle *handle,
131                 [in]     winreg_String key
132         );
133
134         /******************/
135         /* Function: 0x08 */
136         WERROR winreg_DeleteValue(
137                 [in,ref] policy_handle *handle,
138                 [in]     winreg_String value
139         );
140
141         typedef struct {
142                 [value(strlen_m_term_null(name)*2)] uint16 length; 
143                 /* size cannot be auto-set by value() as it is the
144                    amount of space the server is allowed to use for this
145                    string in the reply, not its current size */
146                 uint16 size;
147                 [size_is(size/2),length_is(length/2),charset(UTF16)] uint16 *name;
148         } winreg_StringBuf;
149
150         /******************/
151         /* Function: 0x09 */
152         WERROR winreg_EnumKey(
153                 [in,ref]        policy_handle    *handle,
154                 [in]            uint32           enum_index,
155                 [in,out,ref]    winreg_StringBuf *name,
156                 [in,out,unique] winreg_StringBuf *keyclass,
157                 [in,out,unique] NTTIME           *last_changed_time
158         );
159
160         typedef struct {
161                 [value(strlen_m_term(name)*2)] uint16 length; 
162                 /* size cannot be auto-set by value() as it is the
163                    amount of space the server is allowed to use for this
164                    string in the reply, not its current size */
165                 uint16 size;
166                 [size_is(size/2),length_is(length/2),charset(UTF16)] uint16 *name;
167         } winreg_ValNameBuf;
168
169         /******************/
170         /* Function: 0x0a */
171
172         WERROR winreg_EnumValue(
173                 [in,ref]        policy_handle *handle,
174                 [in]            uint32 enum_index,
175                 [in,out,ref]    winreg_ValNameBuf *name,
176                 [in,out,unique] winreg_Type *type,
177                 [in,out,unique,size_is(*size),length_is(*length)] uint8 *value,
178                 [in,out,unique] uint32 *size,
179                 [in,out,unique] uint32 *length
180         );
181
182         /******************/
183         /* Function: 0x0b */
184         WERROR winreg_FlushKey(
185                 [in,ref] policy_handle *handle
186         );
187
188         /******************/
189         /* Function: 0x0c */
190         WERROR winreg_GetKeySecurity(
191                 [in,ref] policy_handle *handle,
192                 [in] security_secinfo sec_info,
193                 [in,out,ref] KeySecurityData *sd
194         );
195
196         /******************/
197         /* Function: 0x0d */
198         WERROR winreg_LoadKey(
199                 [in,ref] policy_handle *handle,
200                 [in,unique] winreg_String *keyname,
201                 [in,unique] winreg_String *filename
202         );
203
204         /******************/
205         /* Function: 0x0e */
206         WERROR winreg_NotifyChangeKeyValue(
207                 [in,ref] policy_handle *handle,
208                 [in] uint8 watch_subtree,
209                 [in] uint32 notify_filter,
210                 [in] uint32 unknown,
211                 [in] winreg_String string1,
212                 [in] winreg_String string2, 
213                 [in] uint32 unknown2
214         );
215
216         /******************/
217         /* Function: 0x0f */
218         WERROR winreg_OpenKey(
219                 [in,ref] policy_handle *parent_handle,
220                 [in] winreg_String keyname,
221                 [in] uint32 unknown,
222                 [in] winreg_AccessMask access_mask,
223                 [out,ref] policy_handle *handle
224         );
225
226         /******************/
227         /* Function: 0x10 */
228         WERROR winreg_QueryInfoKey(
229                 [in,ref] policy_handle *handle,
230                 [in,out,ref] winreg_String *classname,
231                 [out,ref] uint32 *num_subkeys,
232                 [out,ref] uint32 *max_subkeylen,
233                 [out,ref] uint32 *max_classlen,
234                 [out,ref] uint32 *num_values,
235                 [out,ref] uint32 *max_valnamelen,
236                 [out,ref] uint32 *max_valbufsize,
237                 [out,ref] uint32 *secdescsize,
238                 [out,ref] NTTIME *last_changed_time
239         );
240
241         /******************/
242         /* Function: 0x11 */
243         WERROR winreg_QueryValue(
244                 [in,ref] policy_handle *handle,
245                 [in,ref] winreg_String *value_name,
246                 [in,out,unique] winreg_Type *type,
247                 [in,out,unique,size_is(*data_size),length_is(*value_length)] uint8 *data,
248                 [in,out,unique] uint32 *data_size,
249                 [in,out,unique] uint32 *value_length
250         );
251
252         /******************/
253         /* Function: 0x12 */
254         WERROR winreg_ReplaceKey(
255         );
256
257         /******************/
258         /* Function: 0x13 */
259         WERROR winreg_RestoreKey(
260                 [in,ref] policy_handle *handle,
261                 [in,ref] winreg_String *filename,
262                 [in]     uint32 flags 
263         );
264
265         /******************/
266         /* Function: 0x14 */
267
268         typedef struct {
269                 uint32 data_size;
270                 KeySecurityData sec_data;
271                 uint8 inherit;
272         } KeySecurityAttribute;
273
274         WERROR winreg_SaveKey(
275                 [in,ref] policy_handle *handle,
276                 [in,ref] winreg_String *filename,
277                 [in,unique] KeySecurityAttribute *sec_attrib
278         );
279
280         /******************/
281         /* Function: 0x15 */
282         WERROR winreg_SetKeySecurity(
283                 [in,ref] policy_handle *handle,
284                 [in] winreg_AccessMask access_mask,
285                 [in,ref] KeySecurityData *sd
286         );
287
288         /******************/
289         /* Function: 0x16 */
290         WERROR winreg_SetValue(
291                 [in,ref]           policy_handle *handle,
292                 [in]               winreg_String name,
293                 [in]               winreg_Type type,
294                 [in,size_is(size),ref] uint8  *data,
295                 [in]               uint32 size
296         );
297
298         /******************/
299         /* Function: 0x17 */
300         WERROR winreg_UnLoadKey(
301         );
302
303         /******************/
304         /* Function: 0x18 */
305         WERROR winreg_InitiateSystemShutdown(
306                 [in,unique] uint16 *hostname,
307                 [in,unique] initshutdown_String *message,
308                 [in]    uint32 timeout,
309                 [in]    uint8 force_apps,
310                 [in]    uint8 reboot
311         );
312
313         /******************/
314         /* Function: 0x19 */
315         WERROR winreg_AbortSystemShutdown(
316                 [in,unique] uint16 *server
317         );
318
319         /******************/
320         /* Function: 0x1a */
321         WERROR winreg_GetVersion(
322                 [in,ref]     policy_handle *handle,
323                 [out,ref]    uint32 *version
324         );
325
326         /******************/
327         /* Function: 0x1b */
328         WERROR winreg_OpenHKCC(
329                 [in,unique] uint16 *system_name,
330                 [in]      winreg_AccessMask access_mask,
331                 [out,ref] policy_handle *handle
332         );
333
334         /******************/
335         /* Function: 0x1c */
336         WERROR winreg_OpenHKDD(
337                 [in,unique] uint16 *system_name,
338                 [in]      winreg_AccessMask access_mask,
339                 [out,ref] policy_handle *handle
340         );
341
342         typedef struct {
343                 winreg_String *name;
344                 winreg_Type type;
345                 uint32 offset;
346                 uint32 length;
347         } QueryMultipleValue;
348         
349         /******************/
350         /* Function: 0x1d */
351         WERROR winreg_QueryMultipleValues(
352                 [in,ref] policy_handle *key_handle, 
353                 [in,out,ref,size_is(num_values),length_is(num_values)] QueryMultipleValue *values,
354                 [in] uint32 num_values,
355                 [in,out,unique,size_is(*buffer_size),length_is(*buffer_size)] uint8 *buffer,
356                 [in,out,ref] uint32 *buffer_size
357         );
358
359         /******************/
360         /* Function: 0x1e */
361         WERROR winreg_InitiateSystemShutdownEx(
362                 [in,unique] uint16 *hostname,
363                 [in,unique] initshutdown_String *message,
364                 [in] uint32 timeout,
365                 [in] uint8 force_apps,
366                 [in] uint8 reboot,
367                 [in] uint32 reason
368         );
369
370         /******************/
371         /* Function: 0x1f */
372         WERROR winreg_SaveKeyEx(
373         );
374
375         /******************/
376         /* Function: 0x20 */
377         WERROR winreg_OpenHKPT(
378                 [in,unique] uint16 *system_name,
379                 [in]      winreg_AccessMask access_mask,
380                 [out,ref] policy_handle *handle
381         );
382
383         /******************/
384         /* Function: 0x21 */
385         WERROR winreg_OpenHKPN(
386                 [in,unique] uint16 *system_name,
387                 [in]      winreg_AccessMask access_mask,
388                 [out,ref] policy_handle *handle
389         );
390
391         /******************/
392         /* Function: 0x22 */
393         WERROR winreg_QueryMultipleValues2(
394         );
395 }