blob: 135be32c0fa567ca75e751578389e0280d7ca7a9 [file] [log] [blame]
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001/*
Fred Drake270e19b2000-06-29 16:14:14 +00002 _winreg.c
Guido van Rossum9f3712c2000-03-28 20:37:15 +00003
4 Windows Registry access module for Python.
5
6 * Simple registry access written by Mark Hammond in win32api
7 module circa 1995.
8 * Bill Tutt expanded the support significantly not long after.
9 * Numerous other people have submitted patches since then.
10 * Ripped from win32api module 03-Feb-2000 by Mark Hammond, and
11 basic Unicode support added.
12
13*/
14
Guido van Rossum9f3712c2000-03-28 20:37:15 +000015#include "Python.h"
16#include "structmember.h"
17#include "malloc.h" /* for alloca */
Guido van Rossume7ba4952007-06-06 23:52:48 +000018#include "windows.h"
Guido van Rossum9f3712c2000-03-28 20:37:15 +000019
20static BOOL PyHKEY_AsHKEY(PyObject *ob, HKEY *pRes, BOOL bNoneOK);
21static PyObject *PyHKEY_FromHKEY(HKEY h);
22static BOOL PyHKEY_Close(PyObject *obHandle);
23
24static char errNotAHandle[] = "Object is not a handle";
25
26/* The win32api module reports the function name that failed,
27 but this concept is not in the Python core.
28 Hopefully it will one day, and in the meantime I dont
29 want to lose this info...
30*/
31#define PyErr_SetFromWindowsErrWithFunction(rc, fnname) \
32 PyErr_SetFromWindowsErr(rc)
33
34/* Forward declares */
35
36/* Doc strings */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000037PyDoc_STRVAR(module_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000038"This module provides access to the Windows registry API.\n"
39"\n"
40"Functions:\n"
41"\n"
42"CloseKey() - Closes a registry key.\n"
43"ConnectRegistry() - Establishes a connection to a predefined registry handle\n"
44" on another computer.\n"
45"CreateKey() - Creates the specified key, or opens it if it already exists.\n"
46"DeleteKey() - Deletes the specified key.\n"
47"DeleteValue() - Removes a named value from the specified registry key.\n"
48"EnumKey() - Enumerates subkeys of the specified open registry key.\n"
49"EnumValue() - Enumerates values of the specified open registry key.\n"
50"FlushKey() - Writes all the attributes of the specified key to the registry.\n"
51"LoadKey() - Creates a subkey under HKEY_USER or HKEY_LOCAL_MACHINE and stores\n"
52" registration information from a specified file into that subkey.\n"
53"OpenKey() - Alias for <om win32api.RegOpenKeyEx>\n"
54"OpenKeyEx() - Opens the specified key.\n"
55"QueryValue() - Retrieves the value associated with the unnamed value for a\n"
56" specified key in the registry.\n"
57"QueryValueEx() - Retrieves the type and data for a specified value name\n"
58" associated with an open registry key.\n"
59"QueryInfoKey() - Returns information about the specified key.\n"
60"SaveKey() - Saves the specified key, and all its subkeys a file.\n"
61"SetValue() - Associates a value with a specified key.\n"
62"SetValueEx() - Stores data in the value field of an open registry key.\n"
63"\n"
64"Special objects:\n"
65"\n"
66"HKEYType -- type object for HKEY objects\n"
67"error -- exception raised for Win32 errors\n"
68"\n"
69"Integer constants:\n"
70"Many constants are defined - see the documentation for each function\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000071"to see what constants are used, and where.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000072
73
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000074PyDoc_STRVAR(CloseKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000075"CloseKey(hkey) - Closes a previously opened registry key.\n"
76"\n"
77"The hkey argument specifies a previously opened key.\n"
78"\n"
79"Note that if the key is not closed using this method, it will be\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000080"closed when the hkey object is destroyed by Python.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000081
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000082PyDoc_STRVAR(ConnectRegistry_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000083"key = ConnectRegistry(computer_name, key) - "
84"Establishes a connection to a predefined registry handle on another computer.\n"
85"\n"
86"computer_name is the name of the remote computer, of the form \\\\computername.\n"
87" If None, the local computer is used.\n"
88"key is the predefined handle to connect to.\n"
89"\n"
90"The return value is the handle of the opened key.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000091"If the function fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000092
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000093PyDoc_STRVAR(CreateKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000094"key = CreateKey(key, sub_key) - Creates or opens the specified key.\n"
95"\n"
96"key is an already open key, or one of the predefined HKEY_* constants\n"
97"sub_key is a string that names the key this method opens or creates.\n"
98" If key is one of the predefined keys, sub_key may be None. In that case,\n"
99" the handle returned is the same key handle passed in to the function.\n"
100"\n"
101"If the key already exists, this function opens the existing key\n"
102"\n"
103"The return value is the handle of the opened key.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000104"If the function fails, an exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000105
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000106PyDoc_STRVAR(DeleteKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000107"DeleteKey(key, sub_key) - Deletes the specified key.\n"
108"\n"
109"key is an already open key, or any one of the predefined HKEY_* constants.\n"
110"sub_key is a string that must be a subkey of the key identified by the key parameter.\n"
111" This value must not be None, and the key may not have subkeys.\n"
112"\n"
113"This method can not delete keys with subkeys.\n"
114"\n"
115"If the method succeeds, the entire key, including all of its values,\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000116"is removed. If the method fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000117
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000118PyDoc_STRVAR(DeleteValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000119"DeleteValue(key, value) - Removes a named value from a registry key.\n"
120"\n"
121"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000122"value is a string that identifies the value to remove.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000123
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000124PyDoc_STRVAR(EnumKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000125"string = EnumKey(key, index) - Enumerates subkeys of an open registry key.\n"
126"\n"
127"key is an already open key, or any one of the predefined HKEY_* constants.\n"
128"index is an integer that identifies the index of the key to retrieve.\n"
129"\n"
130"The function retrieves the name of one subkey each time it is called.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000131"It is typically called repeatedly until an EnvironmentError exception is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000132"raised, indicating no more values are available.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000133
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000134PyDoc_STRVAR(EnumValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000135"tuple = EnumValue(key, index) - Enumerates values of an open registry key.\n"
136"key is an already open key, or any one of the predefined HKEY_* constants.\n"
137"index is an integer that identifies the index of the value to retrieve.\n"
138"\n"
139"The function retrieves the name of one subkey each time it is called.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000140"It is typically called repeatedly, until an EnvironmentError exception\n"
141"is raised, indicating no more values.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000142"\n"
143"The result is a tuple of 3 items:\n"
144"value_name is a string that identifies the value.\n"
145"value_data is an object that holds the value data, and whose type depends\n"
146" on the underlying registry type.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000147"data_type is an integer that identifies the type of the value data.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000148
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000149PyDoc_STRVAR(FlushKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000150"FlushKey(key) - Writes all the attributes of a key to the registry.\n"
151"\n"
152"key is an already open key, or any one of the predefined HKEY_* constants.\n"
153"\n"
154"It is not necessary to call RegFlushKey to change a key.\n"
155"Registry changes are flushed to disk by the registry using its lazy flusher.\n"
156"Registry changes are also flushed to disk at system shutdown.\n"
157"Unlike CloseKey(), the FlushKey() method returns only when all the data has\n"
158"been written to the registry.\n"
159"An application should only call FlushKey() if it requires absolute certainty that registry changes are on disk.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000160"If you don't know whether a FlushKey() call is required, it probably isn't.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000161
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000162PyDoc_STRVAR(LoadKey_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000163"LoadKey(key, sub_key, file_name) - Creates a subkey under the specified key\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000164"and stores registration information from a specified file into that subkey.\n"
165"\n"
166"key is an already open key, or any one of the predefined HKEY_* constants.\n"
167"sub_key is a string that identifies the sub_key to load\n"
168"file_name is the name of the file to load registry data from.\n"
169" This file must have been created with the SaveKey() function.\n"
170" Under the file allocation table (FAT) file system, the filename may not\n"
171"have an extension.\n"
172"\n"
173"A call to LoadKey() fails if the calling process does not have the\n"
174"SE_RESTORE_PRIVILEGE privilege.\n"
175"\n"
176"If key is a handle returned by ConnectRegistry(), then the path specified\n"
177"in fileName is relative to the remote computer.\n"
178"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000179"The docs imply key must be in the HKEY_USER or HKEY_LOCAL_MACHINE tree");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000180
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000181PyDoc_STRVAR(OpenKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000182"key = OpenKey(key, sub_key, res = 0, sam = KEY_READ) - Opens the specified key.\n"
183"\n"
184"key is an already open key, or any one of the predefined HKEY_* constants.\n"
185"sub_key is a string that identifies the sub_key to open\n"
186"res is a reserved integer, and must be zero. Default is zero.\n"
187"sam is an integer that specifies an access mask that describes the desired\n"
188" security access for the key. Default is KEY_READ\n"
189"\n"
190"The result is a new handle to the specified key\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000191"If the function fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000192
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000193PyDoc_STRVAR(OpenKeyEx_doc, "See OpenKey()");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000194
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000195PyDoc_STRVAR(QueryInfoKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000196"tuple = QueryInfoKey(key) - Returns information about a key.\n"
197"\n"
198"key is an already open key, or any one of the predefined HKEY_* constants.\n"
199"\n"
200"The result is a tuple of 3 items:"
201"An integer that identifies the number of sub keys this key has.\n"
202"An integer that identifies the number of values this key has.\n"
203"A long integer that identifies when the key was last modified (if available)\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000204" as 100's of nanoseconds since Jan 1, 1600.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000205
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000206PyDoc_STRVAR(QueryValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000207"string = QueryValue(key, sub_key) - retrieves the unnamed value for a key.\n"
208"\n"
209"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000210"sub_key is a string that holds the name of the subkey with which the value\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000211" is associated. If this parameter is None or empty, the function retrieves\n"
212" the value set by the SetValue() method for the key identified by key."
213"\n"
214"Values in the registry have name, type, and data components. This method\n"
215"retrieves the data for a key's first value that has a NULL name.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000216"But the underlying API call doesn't return the type, Lame Lame Lame, DONT USE THIS!!!");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000217
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000218PyDoc_STRVAR(QueryValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000219"value,type_id = QueryValueEx(key, value_name) - Retrieves the type and data for a specified value name associated with an open registry key.\n"
220"\n"
221"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000222"value_name is a string indicating the value to query");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000223
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000224PyDoc_STRVAR(SaveKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000225"SaveKey(key, file_name) - Saves the specified key, and all its subkeys to the specified file.\n"
226"\n"
227"key is an already open key, or any one of the predefined HKEY_* constants.\n"
228"file_name is the name of the file to save registry data to.\n"
229" This file cannot already exist. If this filename includes an extension,\n"
230" it cannot be used on file allocation table (FAT) file systems by the\n"
231" LoadKey(), ReplaceKey() or RestoreKey() methods.\n"
232"\n"
233"If key represents a key on a remote computer, the path described by\n"
234"file_name is relative to the remote computer.\n"
235"The caller of this method must possess the SeBackupPrivilege security privilege.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000236"This function passes NULL for security_attributes to the API.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000237
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000238PyDoc_STRVAR(SetValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000239"SetValue(key, sub_key, type, value) - Associates a value with a specified key.\n"
240"\n"
241"key is an already open key, or any one of the predefined HKEY_* constants.\n"
242"sub_key is a string that names the subkey with which the value is associated.\n"
243"type is an integer that specifies the type of the data. Currently this\n"
244" must be REG_SZ, meaning only strings are supported.\n"
245"value is a string that specifies the new value.\n"
246"\n"
247"If the key specified by the sub_key parameter does not exist, the SetValue\n"
248"function creates it.\n"
249"\n"
250"Value lengths are limited by available memory. Long values (more than\n"
251"2048 bytes) should be stored as files with the filenames stored in \n"
252"the configuration registry. This helps the registry perform efficiently.\n"
253"\n"
254"The key identified by the key parameter must have been opened with\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000255"KEY_SET_VALUE access.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000256
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000257PyDoc_STRVAR(SetValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000258"SetValueEx(key, value_name, reserved, type, value) - Stores data in the value field of an open registry key.\n"
259"\n"
260"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondc9083b62003-01-15 23:38:15 +0000261"value_name is a string containing the name of the value to set, or None\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000262"type is an integer that specifies the type of the data. This should be one of:\n"
263" REG_BINARY -- Binary data in any form.\n"
264" REG_DWORD -- A 32-bit number.\n"
265" REG_DWORD_LITTLE_ENDIAN -- A 32-bit number in little-endian format.\n"
266" REG_DWORD_BIG_ENDIAN -- A 32-bit number in big-endian format.\n"
267" REG_EXPAND_SZ -- A null-terminated string that contains unexpanded references\n"
268" to environment variables (for example, %PATH%).\n"
269" REG_LINK -- A Unicode symbolic link.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000270" REG_MULTI_SZ -- An sequence of null-terminated strings, terminated by\n"
271" two null characters. Note that Python handles this\n"
272" termination automatically.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000273" REG_NONE -- No defined value type.\n"
274" REG_RESOURCE_LIST -- A device-driver resource list.\n"
275" REG_SZ -- A null-terminated string.\n"
276"reserved can be anything - zero is always passed to the API.\n"
277"value is a string that specifies the new value.\n"
278"\n"
279"This method can also set additional value and type information for the\n"
280"specified key. The key identified by the key parameter must have been\n"
281"opened with KEY_SET_VALUE access.\n"
282"\n"
283"To open the key, use the CreateKeyEx() or OpenKeyEx() methods.\n"
284"\n"
285"Value lengths are limited by available memory. Long values (more than\n"
286"2048 bytes) should be stored as files with the filenames stored in \n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000287"the configuration registry. This helps the registry perform efficiently.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000288
289/* PyHKEY docstrings */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000290PyDoc_STRVAR(PyHKEY_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000291"PyHKEY Object - A Python object, representing a win32 registry key.\n"
292"\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000293"This object wraps a Windows HKEY object, automatically closing it when\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000294"the object is destroyed. To guarantee cleanup, you can call either\n"
295"the Close() method on the PyHKEY, or the CloseKey() method.\n"
296"\n"
297"All functions which accept a handle object also accept an integer - \n"
298"however, use of the handle object is encouraged.\n"
299"\n"
300"Functions:\n"
301"Close() - Closes the underlying handle.\n"
302"Detach() - Returns the integer Win32 handle, detaching it from the object\n"
303"\n"
304"Properties:\n"
305"handle - The integer Win32 handle.\n"
306"\n"
307"Operations:\n"
Jack Diederich4dafcc42006-11-28 19:15:13 +0000308"__bool__ - Handles with an open object return true, otherwise false.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000309"__int__ - Converting a handle to an integer returns the Win32 handle.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000310"__cmp__ - Handle objects are compared using the handle value.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000311
312
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000313PyDoc_STRVAR(PyHKEY_Close_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000314"key.Close() - Closes the underlying Windows handle.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000315"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000316"If the handle is already closed, no error is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000317
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000318PyDoc_STRVAR(PyHKEY_Detach_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000319"int = key.Detach() - Detaches the Windows handle from the handle object.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000320"\n"
321"The result is the value of the handle before it is detached. If the\n"
322"handle is already detached, this will return zero.\n"
323"\n"
324"After calling this function, the handle is effectively invalidated,\n"
325"but the handle is not closed. You would call this function when you\n"
326"need the underlying win32 handle to exist beyond the lifetime of the\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000327"handle object.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000328"On 64 bit windows, the result of this function is a long integer");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000329
330
331/************************************************************************
332
333 The PyHKEY object definition
334
335************************************************************************/
336typedef struct {
337 PyObject_VAR_HEAD
338 HKEY hkey;
339} PyHKEYObject;
340
341#define PyHKEY_Check(op) ((op)->ob_type == &PyHKEY_Type)
342
343static char *failMsg = "bad operand type";
344
345static PyObject *
346PyHKEY_unaryFailureFunc(PyObject *ob)
347{
348 PyErr_SetString(PyExc_TypeError, failMsg);
349 return NULL;
350}
351static PyObject *
352PyHKEY_binaryFailureFunc(PyObject *ob1, PyObject *ob2)
353{
354 PyErr_SetString(PyExc_TypeError, failMsg);
355 return NULL;
356}
357static PyObject *
358PyHKEY_ternaryFailureFunc(PyObject *ob1, PyObject *ob2, PyObject *ob3)
359{
360 PyErr_SetString(PyExc_TypeError, failMsg);
361 return NULL;
362}
363
364static void
365PyHKEY_deallocFunc(PyObject *ob)
366{
367 /* Can not call PyHKEY_Close, as the ob->tp_type
368 has already been cleared, thus causing the type
369 check to fail!
370 */
371 PyHKEYObject *obkey = (PyHKEYObject *)ob;
372 if (obkey->hkey)
373 RegCloseKey((HKEY)obkey->hkey);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000374 PyObject_DEL(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000375}
376
377static int
Jack Diederich4dafcc42006-11-28 19:15:13 +0000378PyHKEY_boolFunc(PyObject *ob)
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000379{
380 return ((PyHKEYObject *)ob)->hkey != 0;
381}
382
383static PyObject *
384PyHKEY_intFunc(PyObject *ob)
385{
386 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
387 return PyLong_FromVoidPtr(pyhkey->hkey);
388}
389
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000390static PyObject *
391PyHKEY_strFunc(PyObject *ob)
392{
393 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
394 char resBuf[160];
395 wsprintf(resBuf, "<PyHKEY:%p>", pyhkey->hkey);
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000396 return PyUnicode_FromString(resBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000397}
398
399static int
400PyHKEY_compareFunc(PyObject *ob1, PyObject *ob2)
401{
402 PyHKEYObject *pyhkey1 = (PyHKEYObject *)ob1;
403 PyHKEYObject *pyhkey2 = (PyHKEYObject *)ob2;
404 return pyhkey1 == pyhkey2 ? 0 :
405 (pyhkey1 < pyhkey2 ? -1 : 1);
406}
407
408static long
409PyHKEY_hashFunc(PyObject *ob)
410{
411 /* Just use the address.
412 XXX - should we use the handle value?
413 */
Fred Drake13634cf2000-06-29 19:17:04 +0000414 return _Py_HashPointer(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000415}
416
417
418static PyNumberMethods PyHKEY_NumberMethods =
419{
420 PyHKEY_binaryFailureFunc, /* nb_add */
421 PyHKEY_binaryFailureFunc, /* nb_subtract */
422 PyHKEY_binaryFailureFunc, /* nb_multiply */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000423 PyHKEY_binaryFailureFunc, /* nb_remainder */
424 PyHKEY_binaryFailureFunc, /* nb_divmod */
425 PyHKEY_ternaryFailureFunc, /* nb_power */
426 PyHKEY_unaryFailureFunc, /* nb_negative */
427 PyHKEY_unaryFailureFunc, /* nb_positive */
428 PyHKEY_unaryFailureFunc, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +0000429 PyHKEY_boolFunc, /* nb_bool */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000430 PyHKEY_unaryFailureFunc, /* nb_invert */
431 PyHKEY_binaryFailureFunc, /* nb_lshift */
432 PyHKEY_binaryFailureFunc, /* nb_rshift */
433 PyHKEY_binaryFailureFunc, /* nb_and */
434 PyHKEY_binaryFailureFunc, /* nb_xor */
435 PyHKEY_binaryFailureFunc, /* nb_or */
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000436 NULL, /* nb_coerce */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000437 PyHKEY_intFunc, /* nb_int */
438 PyHKEY_unaryFailureFunc, /* nb_long */
439 PyHKEY_unaryFailureFunc, /* nb_float */
440 PyHKEY_unaryFailureFunc, /* nb_oct */
441 PyHKEY_unaryFailureFunc, /* nb_hex */
442};
443
444
445/* fwd declare __getattr__ */
Tim Petersc3d12ac2005-12-24 06:03:06 +0000446static PyObject *PyHKEY_getattr(PyObject *self, const char *name);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000447
448/* The type itself */
449PyTypeObject PyHKEY_Type =
450{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000451 PyVarObject_HEAD_INIT(0, 0) /* fill in type at module init */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000452 "PyHKEY",
453 sizeof(PyHKEYObject),
454 0,
455 PyHKEY_deallocFunc, /* tp_dealloc */
Guido van Rossum346f1a82007-08-07 19:58:47 +0000456 0, /* tp_print */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000457 PyHKEY_getattr, /* tp_getattr */
458 0, /* tp_setattr */
459 PyHKEY_compareFunc, /* tp_compare */
460 0, /* tp_repr */
461 &PyHKEY_NumberMethods, /* tp_as_number */
462 0, /* tp_as_sequence */
463 0, /* tp_as_mapping */
464 PyHKEY_hashFunc, /* tp_hash */
465 0, /* tp_call */
466 PyHKEY_strFunc, /* tp_str */
467 0, /* tp_getattro */
468 0, /* tp_setattro */
469 0, /* tp_as_buffer */
470 0, /* tp_flags */
471 PyHKEY_doc, /* tp_doc */
472};
473
474#define OFF(e) offsetof(PyHKEYObject, e)
475
Neal Norwitz8dfc4a92007-08-11 06:39:53 +0000476static PyMemberDef PyHKEY_memberlist[] = {
477 {"handle", T_INT, OFF(hkey), READONLY},
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000478 {NULL} /* Sentinel */
479};
480
481/************************************************************************
482
483 The PyHKEY object methods
484
485************************************************************************/
486static PyObject *
487PyHKEY_CloseMethod(PyObject *self, PyObject *args)
488{
489 if (!PyArg_ParseTuple(args, ":Close"))
490 return NULL;
491 if (!PyHKEY_Close(self))
492 return NULL;
493 Py_INCREF(Py_None);
494 return Py_None;
495}
496
497static PyObject *
498PyHKEY_DetachMethod(PyObject *self, PyObject *args)
499{
500 void* ret;
501 PyHKEYObject *pThis = (PyHKEYObject *)self;
502 if (!PyArg_ParseTuple(args, ":Detach"))
503 return NULL;
504 ret = (void*)pThis->hkey;
505 pThis->hkey = 0;
506 return PyLong_FromVoidPtr(ret);
507}
508
509static struct PyMethodDef PyHKEY_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +0000510 {"Close", PyHKEY_CloseMethod, METH_VARARGS, PyHKEY_Close_doc},
511 {"Detach", PyHKEY_DetachMethod, METH_VARARGS, PyHKEY_Detach_doc},
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000512 {NULL}
513};
514
515/*static*/ PyObject *
Tim Petersc3d12ac2005-12-24 06:03:06 +0000516PyHKEY_getattr(PyObject *self, const char *name)
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000517{
518 PyObject *res;
519
520 res = Py_FindMethod(PyHKEY_methods, self, name);
521 if (res != NULL)
522 return res;
523 PyErr_Clear();
524 if (strcmp(name, "handle") == 0)
525 return PyLong_FromVoidPtr(((PyHKEYObject *)self)->hkey);
Neal Norwitz8dfc4a92007-08-11 06:39:53 +0000526 PyErr_Format(PyExc_AttributeError,
527 "'%.50s' object has no attribute '%.400s'",
528 Py_Type(self)->tp_name, name);
529 return NULL;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000530}
531
532/************************************************************************
533 The public PyHKEY API (well, not public yet :-)
534************************************************************************/
535PyObject *
536PyHKEY_New(HKEY hInit)
537{
538 PyHKEYObject *key = PyObject_NEW(PyHKEYObject, &PyHKEY_Type);
539 if (key)
540 key->hkey = hInit;
541 return (PyObject *)key;
542}
543
544BOOL
545PyHKEY_Close(PyObject *ob_handle)
546{
547 LONG rc;
548 PyHKEYObject *key;
549
550 if (!PyHKEY_Check(ob_handle)) {
551 PyErr_SetString(PyExc_TypeError, "bad operand type");
552 return FALSE;
553 }
554 key = (PyHKEYObject *)ob_handle;
555 rc = key->hkey ? RegCloseKey((HKEY)key->hkey) : ERROR_SUCCESS;
556 key->hkey = 0;
557 if (rc != ERROR_SUCCESS)
558 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
559 return rc == ERROR_SUCCESS;
560}
561
562BOOL
563PyHKEY_AsHKEY(PyObject *ob, HKEY *pHANDLE, BOOL bNoneOK)
564{
565 if (ob == Py_None) {
566 if (!bNoneOK) {
567 PyErr_SetString(
568 PyExc_TypeError,
569 "None is not a valid HKEY in this context");
570 return FALSE;
571 }
572 *pHANDLE = (HKEY)0;
573 }
574 else if (PyHKEY_Check(ob)) {
575 PyHKEYObject *pH = (PyHKEYObject *)ob;
576 *pHANDLE = pH->hkey;
577 }
578 else if (PyInt_Check(ob) || PyLong_Check(ob)) {
579 /* We also support integers */
580 PyErr_Clear();
581 *pHANDLE = (HKEY)PyLong_AsVoidPtr(ob);
582 if (PyErr_Occurred())
583 return FALSE;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000584 }
585 else {
586 PyErr_SetString(
587 PyExc_TypeError,
588 "The object is not a PyHKEY object");
589 return FALSE;
590 }
591 return TRUE;
592}
593
594PyObject *
595PyHKEY_FromHKEY(HKEY h)
596{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000597 PyHKEYObject *op;
598
Guido van Rossume3a8e7e2002-08-19 19:26:42 +0000599 /* Inline PyObject_New */
Guido van Rossumb18618d2000-05-03 23:44:39 +0000600 op = (PyHKEYObject *) PyObject_MALLOC(sizeof(PyHKEYObject));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000601 if (op == NULL)
602 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000603 PyObject_INIT(op, &PyHKEY_Type);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000604 op->hkey = h;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000605 return (PyObject *)op;
606}
607
608
609/************************************************************************
610 The module methods
611************************************************************************/
612BOOL
613PyWinObject_CloseHKEY(PyObject *obHandle)
614{
615 BOOL ok;
616 if (PyHKEY_Check(obHandle)) {
617 ok = PyHKEY_Close(obHandle);
618 }
Fred Drake25e17262000-06-30 17:48:51 +0000619#if SIZEOF_LONG >= SIZEOF_HKEY
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000620 else if (PyInt_Check(obHandle)) {
621 long rc = RegCloseKey((HKEY)PyInt_AsLong(obHandle));
622 ok = (rc == ERROR_SUCCESS);
623 if (!ok)
624 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
625 }
Fred Drake25e17262000-06-30 17:48:51 +0000626#else
627 else if (PyLong_Check(obHandle)) {
628 long rc = RegCloseKey((HKEY)PyLong_AsVoidPtr(obHandle));
629 ok = (rc == ERROR_SUCCESS);
630 if (!ok)
631 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
632 }
633#endif
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000634 else {
635 PyErr_SetString(
636 PyExc_TypeError,
637 "A handle must be a HKEY object or an integer");
638 return FALSE;
639 }
640 return ok;
641}
642
643
644/*
645 Private Helper functions for the registry interfaces
646
647** Note that fixupMultiSZ and countString have both had changes
648** made to support "incorrect strings". The registry specification
649** calls for strings to be terminated with 2 null bytes. It seems
Thomas Wouters7e474022000-07-16 12:04:32 +0000650** some commercial packages install strings which dont conform,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000651** causing this code to fail - however, "regedit" etc still work
652** with these strings (ie only we dont!).
653*/
654static void
655fixupMultiSZ(char **str, char *data, int len)
656{
657 char *P;
658 int i;
659 char *Q;
660
661 Q = data + len;
662 for (P = data, i = 0; P < Q && *P != '\0'; P++, i++) {
663 str[i] = P;
664 for(; *P != '\0'; P++)
665 ;
666 }
667}
668
669static int
670countStrings(char *data, int len)
671{
672 int strings;
673 char *P;
674 char *Q = data + len;
675
676 for (P = data, strings = 0; P < Q && *P != '\0'; P++, strings++)
677 for (; P < Q && *P != '\0'; P++)
678 ;
679 return strings;
680}
681
682/* Convert PyObject into Registry data.
683 Allocates space as needed. */
684static BOOL
685Py2Reg(PyObject *value, DWORD typ, BYTE **retDataBuf, DWORD *retDataSize)
686{
687 int i,j;
Guido van Rossum7eaf8222007-06-18 17:58:50 +0000688 DWORD d;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000689 switch (typ) {
690 case REG_DWORD:
Guido van Rossum7eaf8222007-06-18 17:58:50 +0000691 if (value != Py_None && !PyLong_Check(value))
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000692 return FALSE;
Guido van Rossumd8faa362007-04-27 19:54:29 +0000693 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, 1);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000694 if (*retDataBuf==NULL){
695 PyErr_NoMemory();
696 return FALSE;
697 }
698 *retDataSize = sizeof(DWORD);
699 if (value == Py_None) {
700 DWORD zero = 0;
701 memcpy(*retDataBuf, &zero, sizeof(DWORD));
702 }
Guido van Rossum7eaf8222007-06-18 17:58:50 +0000703 else {
704 d = PyLong_AsLong(value);
705 memcpy(*retDataBuf, &d, sizeof(DWORD));
706 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000707 break;
708 case REG_SZ:
709 case REG_EXPAND_SZ:
710 {
711 int need_decref = 0;
712 if (value == Py_None)
713 *retDataSize = 1;
714 else {
715 if (PyUnicode_Check(value)) {
716 value = PyUnicode_AsEncodedString(
717 value,
718 "mbcs",
719 NULL);
720 if (value==NULL)
721 return FALSE;
722 need_decref = 1;
723 }
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000724 if (!PyBytes_Check(value))
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000725 return FALSE;
726 *retDataSize = 1 + strlen(
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000727 PyBytes_AS_STRING(value));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000728 }
729 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, *retDataSize);
730 if (*retDataBuf==NULL){
731 PyErr_NoMemory();
732 return FALSE;
733 }
734 if (value == Py_None)
735 strcpy((char *)*retDataBuf, "");
736 else
737 strcpy((char *)*retDataBuf,
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000738 PyBytes_AS_STRING(value));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000739 if (need_decref)
740 Py_DECREF(value);
741 break;
742 }
743 case REG_MULTI_SZ:
744 {
745 DWORD size = 0;
746 char *P;
747 PyObject **obs = NULL;
748
749 if (value == Py_None)
750 i = 0;
751 else {
752 if (!PyList_Check(value))
753 return FALSE;
754 i = PyList_Size(value);
755 }
756 obs = malloc(sizeof(PyObject *) * i);
757 memset(obs, 0, sizeof(PyObject *) * i);
758 for (j = 0; j < i; j++)
759 {
760 PyObject *t;
761 t = PyList_GET_ITEM(
762 (PyListObject *)value,j);
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000763 if (PyBytes_Check(t)) {
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000764 obs[j] = t;
765 Py_INCREF(t);
766 } else if (PyUnicode_Check(t)) {
767 obs[j] = PyUnicode_AsEncodedString(
768 t,
769 "mbcs",
770 NULL);
771 if (obs[j]==NULL)
772 goto reg_multi_fail;
773 } else
774 goto reg_multi_fail;
775 size += 1 + strlen(
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000776 PyBytes_AS_STRING(obs[j]));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000777 }
778
779 *retDataSize = size + 1;
780 *retDataBuf = (BYTE *)PyMem_NEW(char,
781 *retDataSize);
782 if (*retDataBuf==NULL){
783 PyErr_NoMemory();
784 goto reg_multi_fail;
785 }
786 P = (char *)*retDataBuf;
787
788 for (j = 0; j < i; j++)
789 {
790 PyObject *t;
791 t = obs[j];
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000792 strcpy(P, PyBytes_AS_STRING(t));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000793 P += 1 + strlen(
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000794 PyBytes_AS_STRING(t));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000795 Py_DECREF(obs[j]);
796 }
797 /* And doubly-terminate the list... */
798 *P = '\0';
799 free(obs);
800 break;
801 reg_multi_fail:
802 if (obs) {
803 for (j = 0; j < i; j++)
804 Py_XDECREF(obs[j]);
805
806 free(obs);
807 }
808 return FALSE;
809 }
810 case REG_BINARY:
811 /* ALSO handle ALL unknown data types here. Even if we can't
812 support it natively, we should handle the bits. */
813 default:
814 if (value == Py_None)
815 *retDataSize = 0;
816 else {
Mark Hammond4e80bb52000-07-28 03:44:41 +0000817 void *src_buf;
818 PyBufferProcs *pb = value->ob_type->tp_as_buffer;
819 if (pb==NULL) {
Tim Peters313fcd42006-02-19 04:05:39 +0000820 PyErr_Format(PyExc_TypeError,
Mark Hammond4e80bb52000-07-28 03:44:41 +0000821 "Objects of type '%s' can not "
Tim Peters313fcd42006-02-19 04:05:39 +0000822 "be used as binary registry values",
Mark Hammond4e80bb52000-07-28 03:44:41 +0000823 value->ob_type->tp_name);
824 return FALSE;
825 }
826 *retDataSize = (*pb->bf_getreadbuffer)(value, 0, &src_buf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000827 *retDataBuf = (BYTE *)PyMem_NEW(char,
828 *retDataSize);
829 if (*retDataBuf==NULL){
830 PyErr_NoMemory();
831 return FALSE;
832 }
Mark Hammond4e80bb52000-07-28 03:44:41 +0000833 memcpy(*retDataBuf, src_buf, *retDataSize);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000834 }
835 break;
836 }
837 return TRUE;
838}
839
840/* Convert Registry data into PyObject*/
841static PyObject *
842Reg2Py(char *retDataBuf, DWORD retDataSize, DWORD typ)
843{
844 PyObject *obData;
845
846 switch (typ) {
847 case REG_DWORD:
848 if (retDataSize == 0)
849 obData = Py_BuildValue("i", 0);
850 else
851 obData = Py_BuildValue("i",
852 *(int *)retDataBuf);
853 break;
854 case REG_SZ:
855 case REG_EXPAND_SZ:
856 /* retDataBuf may or may not have a trailing NULL in
857 the buffer. */
858 if (retDataSize && retDataBuf[retDataSize-1] == '\0')
859 --retDataSize;
860 if (retDataSize ==0)
861 retDataBuf = "";
862 obData = PyUnicode_DecodeMBCS(retDataBuf,
863 retDataSize,
864 NULL);
865 break;
866 case REG_MULTI_SZ:
867 if (retDataSize == 0)
868 obData = PyList_New(0);
869 else
870 {
871 int index = 0;
872 int s = countStrings(retDataBuf, retDataSize);
873 char **str = (char **)malloc(sizeof(char *)*s);
874 if (str == NULL)
875 return PyErr_NoMemory();
876
877 fixupMultiSZ(str, retDataBuf, retDataSize);
878 obData = PyList_New(s);
Fred Drake25e17262000-06-30 17:48:51 +0000879 if (obData == NULL)
880 return NULL;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000881 for (index = 0; index < s; index++)
882 {
Fred Drake25e17262000-06-30 17:48:51 +0000883 size_t len = _mbstrlen(str[index]);
884 if (len > INT_MAX) {
885 PyErr_SetString(PyExc_OverflowError,
886 "registry string is too long for a Python string");
887 Py_DECREF(obData);
888 return NULL;
889 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000890 PyList_SetItem(obData,
891 index,
892 PyUnicode_DecodeMBCS(
893 (const char *)str[index],
Fred Drake25e17262000-06-30 17:48:51 +0000894 (int)len,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000895 NULL)
896 );
897 }
898 free(str);
899
900 break;
901 }
902 case REG_BINARY:
903 /* ALSO handle ALL unknown data types here. Even if we can't
904 support it natively, we should handle the bits. */
905 default:
906 if (retDataSize == 0) {
907 Py_INCREF(Py_None);
908 obData = Py_None;
909 }
910 else
Guido van Rossuma8c360e2007-07-17 20:50:43 +0000911 obData = Py_BuildValue("y#",
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000912 (char *)retDataBuf,
913 retDataSize);
914 break;
915 }
916 if (obData == NULL)
917 return NULL;
918 else
919 return obData;
920}
921
922/* The Python methods */
923
924static PyObject *
925PyCloseKey(PyObject *self, PyObject *args)
926{
927 PyObject *obKey;
928 if (!PyArg_ParseTuple(args, "O:CloseKey", &obKey))
929 return NULL;
930 if (!PyHKEY_Close(obKey))
931 return NULL;
932 Py_INCREF(Py_None);
933 return Py_None;
934}
935
936static PyObject *
937PyConnectRegistry(PyObject *self, PyObject *args)
938{
939 HKEY hKey;
940 PyObject *obKey;
941 char *szCompName = NULL;
942 HKEY retKey;
943 long rc;
944 if (!PyArg_ParseTuple(args, "zO:ConnectRegistry", &szCompName, &obKey))
945 return NULL;
946 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
947 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000948 Py_BEGIN_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000949 rc = RegConnectRegistry(szCompName, hKey, &retKey);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000950 Py_END_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000951 if (rc != ERROR_SUCCESS)
952 return PyErr_SetFromWindowsErrWithFunction(rc,
953 "ConnectRegistry");
954 return PyHKEY_FromHKEY(retKey);
955}
956
957static PyObject *
958PyCreateKey(PyObject *self, PyObject *args)
959{
960 HKEY hKey;
961 PyObject *obKey;
962 char *subKey;
963 HKEY retKey;
964 long rc;
965 if (!PyArg_ParseTuple(args, "Oz:CreateKey", &obKey, &subKey))
966 return NULL;
967 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
968 return NULL;
969 rc = RegCreateKey(hKey, subKey, &retKey);
970 if (rc != ERROR_SUCCESS)
971 return PyErr_SetFromWindowsErrWithFunction(rc, "CreateKey");
972 return PyHKEY_FromHKEY(retKey);
973}
974
975static PyObject *
976PyDeleteKey(PyObject *self, PyObject *args)
977{
978 HKEY hKey;
979 PyObject *obKey;
980 char *subKey;
981 long rc;
982 if (!PyArg_ParseTuple(args, "Os:DeleteKey", &obKey, &subKey))
983 return NULL;
984 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
985 return NULL;
986 rc = RegDeleteKey(hKey, subKey );
987 if (rc != ERROR_SUCCESS)
988 return PyErr_SetFromWindowsErrWithFunction(rc, "RegDeleteKey");
989 Py_INCREF(Py_None);
990 return Py_None;
991}
992
993static PyObject *
994PyDeleteValue(PyObject *self, PyObject *args)
995{
996 HKEY hKey;
997 PyObject *obKey;
998 char *subKey;
999 long rc;
1000 if (!PyArg_ParseTuple(args, "Oz:DeleteValue", &obKey, &subKey))
1001 return NULL;
1002 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1003 return NULL;
1004 Py_BEGIN_ALLOW_THREADS
1005 rc = RegDeleteValue(hKey, subKey);
1006 Py_END_ALLOW_THREADS
1007 if (rc !=ERROR_SUCCESS)
1008 return PyErr_SetFromWindowsErrWithFunction(rc,
1009 "RegDeleteValue");
1010 Py_INCREF(Py_None);
1011 return Py_None;
1012}
1013
1014static PyObject *
1015PyEnumKey(PyObject *self, PyObject *args)
1016{
1017 HKEY hKey;
1018 PyObject *obKey;
1019 int index;
1020 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001021 PyObject *retStr;
Georg Brandl9a928e72006-02-18 23:35:11 +00001022 char tmpbuf[256]; /* max key name length is 255 */
Georg Brandlb2699b22006-02-18 23:44:24 +00001023 DWORD len = sizeof(tmpbuf); /* includes NULL terminator */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001024
1025 if (!PyArg_ParseTuple(args, "Oi:EnumKey", &obKey, &index))
1026 return NULL;
1027 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1028 return NULL;
Tim Peters313fcd42006-02-19 04:05:39 +00001029
Georg Brandl9a928e72006-02-18 23:35:11 +00001030 Py_BEGIN_ALLOW_THREADS
1031 rc = RegEnumKeyEx(hKey, index, tmpbuf, &len, NULL, NULL, NULL, NULL);
1032 Py_END_ALLOW_THREADS
1033 if (rc != ERROR_SUCCESS)
1034 return PyErr_SetFromWindowsErrWithFunction(rc, "RegEnumKeyEx");
Tim Peters313fcd42006-02-19 04:05:39 +00001035
Guido van Rossuma8c360e2007-07-17 20:50:43 +00001036 retStr = PyUnicode_FromStringAndSize(tmpbuf, len);
Georg Brandl9a928e72006-02-18 23:35:11 +00001037 return retStr; /* can be NULL */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001038}
1039
1040static PyObject *
1041PyEnumValue(PyObject *self, PyObject *args)
1042{
1043 HKEY hKey;
1044 PyObject *obKey;
1045 int index;
1046 long rc;
1047 char *retValueBuf;
1048 char *retDataBuf;
1049 DWORD retValueSize;
1050 DWORD retDataSize;
1051 DWORD typ;
1052 PyObject *obData;
1053 PyObject *retVal;
1054
1055 if (!PyArg_ParseTuple(args, "Oi:EnumValue", &obKey, &index))
1056 return NULL;
1057 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1058 return NULL;
1059
1060 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, NULL, NULL, NULL, NULL,
1061 NULL,
1062 &retValueSize, &retDataSize, NULL, NULL))
1063 != ERROR_SUCCESS)
1064 return PyErr_SetFromWindowsErrWithFunction(rc,
1065 "RegQueryInfoKey");
1066 ++retValueSize; /* include null terminators */
1067 ++retDataSize;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001068 retValueBuf = (char *)PyMem_Malloc(retValueSize);
1069 if (retValueBuf == NULL)
1070 return PyErr_NoMemory();
1071 retDataBuf = (char *)PyMem_Malloc(retDataSize);
1072 if (retDataBuf == NULL) {
1073 PyMem_Free(retValueBuf);
1074 return PyErr_NoMemory();
1075 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001076
1077 Py_BEGIN_ALLOW_THREADS
1078 rc = RegEnumValue(hKey,
1079 index,
1080 retValueBuf,
1081 &retValueSize,
1082 NULL,
1083 &typ,
1084 (BYTE *)retDataBuf,
1085 &retDataSize);
1086 Py_END_ALLOW_THREADS
1087
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001088 if (rc != ERROR_SUCCESS) {
1089 retVal = PyErr_SetFromWindowsErrWithFunction(rc,
1090 "PyRegEnumValue");
1091 goto fail;
1092 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001093 obData = Reg2Py(retDataBuf, retDataSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001094 if (obData == NULL) {
1095 retVal = NULL;
1096 goto fail;
1097 }
Guido van Rossuma8c360e2007-07-17 20:50:43 +00001098 retVal = Py_BuildValue("UOi", retValueBuf, obData, typ);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001099 Py_DECREF(obData);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001100 fail:
1101 PyMem_Free(retValueBuf);
1102 PyMem_Free(retDataBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001103 return retVal;
1104}
1105
1106static PyObject *
1107PyFlushKey(PyObject *self, PyObject *args)
1108{
1109 HKEY hKey;
1110 PyObject *obKey;
1111 long rc;
1112 if (!PyArg_ParseTuple(args, "O:FlushKey", &obKey))
1113 return NULL;
1114 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1115 return NULL;
1116 Py_BEGIN_ALLOW_THREADS
1117 rc = RegFlushKey(hKey);
1118 Py_END_ALLOW_THREADS
1119 if (rc != ERROR_SUCCESS)
1120 return PyErr_SetFromWindowsErrWithFunction(rc, "RegFlushKey");
1121 Py_INCREF(Py_None);
1122 return Py_None;
1123}
1124static PyObject *
1125PyLoadKey(PyObject *self, PyObject *args)
1126{
1127 HKEY hKey;
1128 PyObject *obKey;
1129 char *subKey;
1130 char *fileName;
1131
1132 long rc;
1133 if (!PyArg_ParseTuple(args, "Oss:LoadKey", &obKey, &subKey, &fileName))
1134 return NULL;
1135 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1136 return NULL;
1137 Py_BEGIN_ALLOW_THREADS
1138 rc = RegLoadKey(hKey, subKey, fileName );
1139 Py_END_ALLOW_THREADS
1140 if (rc != ERROR_SUCCESS)
1141 return PyErr_SetFromWindowsErrWithFunction(rc, "RegLoadKey");
1142 Py_INCREF(Py_None);
1143 return Py_None;
1144}
1145
1146static PyObject *
1147PyOpenKey(PyObject *self, PyObject *args)
1148{
1149 HKEY hKey;
1150 PyObject *obKey;
1151
1152 char *subKey;
1153 int res = 0;
1154 HKEY retKey;
1155 long rc;
1156 REGSAM sam = KEY_READ;
1157 if (!PyArg_ParseTuple(args, "Oz|ii:OpenKey", &obKey, &subKey,
1158 &res, &sam))
1159 return NULL;
1160 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1161 return NULL;
1162
1163 Py_BEGIN_ALLOW_THREADS
1164 rc = RegOpenKeyEx(hKey, subKey, res, sam, &retKey);
1165 Py_END_ALLOW_THREADS
1166 if (rc != ERROR_SUCCESS)
1167 return PyErr_SetFromWindowsErrWithFunction(rc, "RegOpenKeyEx");
1168 return PyHKEY_FromHKEY(retKey);
1169}
1170
1171
1172static PyObject *
1173PyQueryInfoKey(PyObject *self, PyObject *args)
1174{
1175 HKEY hKey;
1176 PyObject *obKey;
1177 long rc;
1178 DWORD nSubKeys, nValues;
1179 FILETIME ft;
1180 LARGE_INTEGER li;
1181 PyObject *l;
1182 PyObject *ret;
1183 if (!PyArg_ParseTuple(args, "O:QueryInfoKey", &obKey))
1184 return NULL;
1185 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1186 return NULL;
1187 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, 0, &nSubKeys, NULL, NULL,
1188 &nValues, NULL, NULL, NULL, &ft))
1189 != ERROR_SUCCESS)
1190 return PyErr_SetFromWindowsErrWithFunction(rc, "RegQueryInfoKey");
1191 li.LowPart = ft.dwLowDateTime;
1192 li.HighPart = ft.dwHighDateTime;
1193 l = PyLong_FromLongLong(li.QuadPart);
1194 if (l == NULL)
1195 return NULL;
1196 ret = Py_BuildValue("iiO", nSubKeys, nValues, l);
1197 Py_DECREF(l);
1198 return ret;
1199}
1200
1201static PyObject *
1202PyQueryValue(PyObject *self, PyObject *args)
1203{
1204 HKEY hKey;
1205 PyObject *obKey;
1206 char *subKey;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001207 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001208 PyObject *retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001209 char *retBuf;
1210 long bufSize = 0;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001211
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001212 if (!PyArg_ParseTuple(args, "Oz:QueryValue", &obKey, &subKey))
1213 return NULL;
1214
1215 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1216 return NULL;
1217 if ((rc = RegQueryValue(hKey, subKey, NULL, &bufSize))
1218 != ERROR_SUCCESS)
1219 return PyErr_SetFromWindowsErrWithFunction(rc,
1220 "RegQueryValue");
Guido van Rossuma8c360e2007-07-17 20:50:43 +00001221 retBuf = (char *)PyMem_Malloc(bufSize);
1222 if (retBuf == NULL)
1223 return PyErr_NoMemory();
1224
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001225 if ((rc = RegQueryValue(hKey, subKey, retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001226 != ERROR_SUCCESS) {
Guido van Rossuma8c360e2007-07-17 20:50:43 +00001227 PyMem_Free(retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001228 return PyErr_SetFromWindowsErrWithFunction(rc,
1229 "RegQueryValue");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001230 }
Guido van Rossuma8c360e2007-07-17 20:50:43 +00001231
1232 retStr = PyUnicode_DecodeMBCS(retBuf, strlen(retBuf), NULL);
1233 PyMem_Free(retBuf);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001234 return retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001235}
1236
1237static PyObject *
1238PyQueryValueEx(PyObject *self, PyObject *args)
1239{
1240 HKEY hKey;
1241 PyObject *obKey;
1242 char *valueName;
1243
1244 long rc;
1245 char *retBuf;
1246 DWORD bufSize = 0;
1247 DWORD typ;
1248 PyObject *obData;
1249 PyObject *result;
1250
1251 if (!PyArg_ParseTuple(args, "Oz:QueryValueEx", &obKey, &valueName))
1252 return NULL;
1253
1254 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1255 return NULL;
1256 if ((rc = RegQueryValueEx(hKey, valueName,
1257 NULL, NULL, NULL,
1258 &bufSize))
1259 != ERROR_SUCCESS)
1260 return PyErr_SetFromWindowsErrWithFunction(rc,
1261 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001262 retBuf = (char *)PyMem_Malloc(bufSize);
1263 if (retBuf == NULL)
1264 return PyErr_NoMemory();
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001265 if ((rc = RegQueryValueEx(hKey, valueName, NULL,
1266 &typ, (BYTE *)retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001267 != ERROR_SUCCESS) {
1268 PyMem_Free(retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001269 return PyErr_SetFromWindowsErrWithFunction(rc,
1270 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001271 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001272 obData = Reg2Py(retBuf, bufSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001273 PyMem_Free((void *)retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001274 if (obData == NULL)
1275 return NULL;
1276 result = Py_BuildValue("Oi", obData, typ);
1277 Py_DECREF(obData);
1278 return result;
1279}
1280
1281
1282static PyObject *
1283PySaveKey(PyObject *self, PyObject *args)
1284{
1285 HKEY hKey;
1286 PyObject *obKey;
1287 char *fileName;
1288 LPSECURITY_ATTRIBUTES pSA = NULL;
1289
1290 long rc;
1291 if (!PyArg_ParseTuple(args, "Os:SaveKey", &obKey, &fileName))
1292 return NULL;
1293 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1294 return NULL;
1295/* One day we may get security into the core?
1296 if (!PyWinObject_AsSECURITY_ATTRIBUTES(obSA, &pSA, TRUE))
1297 return NULL;
1298*/
1299 Py_BEGIN_ALLOW_THREADS
1300 rc = RegSaveKey(hKey, fileName, pSA );
1301 Py_END_ALLOW_THREADS
1302 if (rc != ERROR_SUCCESS)
1303 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSaveKey");
1304 Py_INCREF(Py_None);
1305 return Py_None;
1306}
1307
1308static PyObject *
1309PySetValue(PyObject *self, PyObject *args)
1310{
1311 HKEY hKey;
1312 PyObject *obKey;
1313 char *subKey;
1314 char *str;
1315 DWORD typ;
1316 DWORD len;
1317 long rc;
1318 PyObject *obStrVal;
1319 PyObject *obSubKey;
1320 if (!PyArg_ParseTuple(args, "OOiO:SetValue",
1321 &obKey,
1322 &obSubKey,
1323 &typ,
1324 &obStrVal))
1325 return NULL;
1326 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1327 return NULL;
1328 if (typ != REG_SZ) {
1329 PyErr_SetString(PyExc_TypeError,
Thomas Hellere1d18f52002-12-20 20:13:35 +00001330 "Type must be _winreg.REG_SZ");
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001331 return NULL;
1332 }
1333 /* XXX - need Unicode support */
1334 str = PyString_AsString(obStrVal);
1335 if (str == NULL)
1336 return NULL;
1337 len = PyString_Size(obStrVal);
1338 if (obSubKey == Py_None)
1339 subKey = NULL;
1340 else {
1341 subKey = PyString_AsString(obSubKey);
1342 if (subKey == NULL)
1343 return NULL;
1344 }
1345 Py_BEGIN_ALLOW_THREADS
1346 rc = RegSetValue(hKey, subKey, REG_SZ, str, len+1);
1347 Py_END_ALLOW_THREADS
1348 if (rc != ERROR_SUCCESS)
1349 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSetValue");
1350 Py_INCREF(Py_None);
1351 return Py_None;
1352}
1353
1354static PyObject *
1355PySetValueEx(PyObject *self, PyObject *args)
1356{
1357 HKEY hKey;
1358 PyObject *obKey;
1359 char *valueName;
1360 PyObject *obRes;
1361 PyObject *value;
1362 BYTE *data;
1363 DWORD len;
1364 DWORD typ;
1365
1366 LONG rc;
1367
1368 if (!PyArg_ParseTuple(args, "OzOiO:SetValueEx",
1369 &obKey,
1370 &valueName,
1371 &obRes,
1372 &typ,
1373 &value))
1374 return NULL;
1375 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1376 return NULL;
1377 if (!Py2Reg(value, typ, &data, &len))
1378 {
1379 if (!PyErr_Occurred())
1380 PyErr_SetString(PyExc_ValueError,
1381 "Could not convert the data to the specified type.");
1382 return NULL;
1383 }
1384 Py_BEGIN_ALLOW_THREADS
1385 rc = RegSetValueEx(hKey, valueName, 0, typ, data, len);
1386 Py_END_ALLOW_THREADS
Guido van Rossumb18618d2000-05-03 23:44:39 +00001387 PyMem_DEL(data);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001388 if (rc != ERROR_SUCCESS)
1389 return PyErr_SetFromWindowsErrWithFunction(rc,
1390 "RegSetValueEx");
1391 Py_INCREF(Py_None);
1392 return Py_None;
1393}
1394
1395static struct PyMethodDef winreg_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001396 {"CloseKey", PyCloseKey, METH_VARARGS, CloseKey_doc},
1397 {"ConnectRegistry", PyConnectRegistry, METH_VARARGS, ConnectRegistry_doc},
1398 {"CreateKey", PyCreateKey, METH_VARARGS, CreateKey_doc},
1399 {"DeleteKey", PyDeleteKey, METH_VARARGS, DeleteKey_doc},
1400 {"DeleteValue", PyDeleteValue, METH_VARARGS, DeleteValue_doc},
1401 {"EnumKey", PyEnumKey, METH_VARARGS, EnumKey_doc},
1402 {"EnumValue", PyEnumValue, METH_VARARGS, EnumValue_doc},
1403 {"FlushKey", PyFlushKey, METH_VARARGS, FlushKey_doc},
1404 {"LoadKey", PyLoadKey, METH_VARARGS, LoadKey_doc},
1405 {"OpenKey", PyOpenKey, METH_VARARGS, OpenKey_doc},
1406 {"OpenKeyEx", PyOpenKey, METH_VARARGS, OpenKeyEx_doc},
1407 {"QueryValue", PyQueryValue, METH_VARARGS, QueryValue_doc},
1408 {"QueryValueEx", PyQueryValueEx, METH_VARARGS, QueryValueEx_doc},
1409 {"QueryInfoKey", PyQueryInfoKey, METH_VARARGS, QueryInfoKey_doc},
1410 {"SaveKey", PySaveKey, METH_VARARGS, SaveKey_doc},
1411 {"SetValue", PySetValue, METH_VARARGS, SetValue_doc},
1412 {"SetValueEx", PySetValueEx, METH_VARARGS, SetValueEx_doc},
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001413 NULL,
1414};
1415
1416static void
1417insint(PyObject * d, char * name, long value)
1418{
1419 PyObject *v = PyInt_FromLong(value);
1420 if (!v || PyDict_SetItemString(d, name, v))
1421 PyErr_Clear();
1422 Py_XDECREF(v);
1423}
1424
1425#define ADD_INT(val) insint(d, #val, val)
1426
1427static void
1428inskey(PyObject * d, char * name, HKEY key)
1429{
1430 PyObject *v = PyLong_FromVoidPtr(key);
1431 if (!v || PyDict_SetItemString(d, name, v))
1432 PyErr_Clear();
1433 Py_XDECREF(v);
1434}
1435
1436#define ADD_KEY(val) inskey(d, #val, val)
1437
Mark Hammond8235ea12002-07-19 06:55:41 +00001438PyMODINIT_FUNC init_winreg(void)
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001439{
1440 PyObject *m, *d;
Fred Drake270e19b2000-06-29 16:14:14 +00001441 m = Py_InitModule3("_winreg", winreg_methods, module_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001442 if (m == NULL)
1443 return;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001444 d = PyModule_GetDict(m);
Martin v. Löwis95c95ce2007-07-22 14:41:55 +00001445 Py_Type(&PyHKEY_Type) = &PyType_Type;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001446 PyHKEY_Type.tp_doc = PyHKEY_doc;
1447 Py_INCREF(&PyHKEY_Type);
1448 if (PyDict_SetItemString(d, "HKEYType",
1449 (PyObject *)&PyHKEY_Type) != 0)
1450 return;
1451 Py_INCREF(PyExc_WindowsError);
1452 if (PyDict_SetItemString(d, "error",
1453 PyExc_WindowsError) != 0)
1454 return;
1455
1456 /* Add the relevant constants */
1457 ADD_KEY(HKEY_CLASSES_ROOT);
1458 ADD_KEY(HKEY_CURRENT_USER);
1459 ADD_KEY(HKEY_LOCAL_MACHINE);
1460 ADD_KEY(HKEY_USERS);
1461 ADD_KEY(HKEY_PERFORMANCE_DATA);
1462#ifdef HKEY_CURRENT_CONFIG
1463 ADD_KEY(HKEY_CURRENT_CONFIG);
1464#endif
1465#ifdef HKEY_DYN_DATA
1466 ADD_KEY(HKEY_DYN_DATA);
1467#endif
1468 ADD_INT(KEY_QUERY_VALUE);
1469 ADD_INT(KEY_SET_VALUE);
1470 ADD_INT(KEY_CREATE_SUB_KEY);
1471 ADD_INT(KEY_ENUMERATE_SUB_KEYS);
1472 ADD_INT(KEY_NOTIFY);
1473 ADD_INT(KEY_CREATE_LINK);
1474 ADD_INT(KEY_READ);
1475 ADD_INT(KEY_WRITE);
1476 ADD_INT(KEY_EXECUTE);
1477 ADD_INT(KEY_ALL_ACCESS);
1478 ADD_INT(REG_OPTION_RESERVED);
1479 ADD_INT(REG_OPTION_NON_VOLATILE);
1480 ADD_INT(REG_OPTION_VOLATILE);
1481 ADD_INT(REG_OPTION_CREATE_LINK);
1482 ADD_INT(REG_OPTION_BACKUP_RESTORE);
1483 ADD_INT(REG_OPTION_OPEN_LINK);
1484 ADD_INT(REG_LEGAL_OPTION);
1485 ADD_INT(REG_CREATED_NEW_KEY);
1486 ADD_INT(REG_OPENED_EXISTING_KEY);
1487 ADD_INT(REG_WHOLE_HIVE_VOLATILE);
1488 ADD_INT(REG_REFRESH_HIVE);
1489 ADD_INT(REG_NO_LAZY_FLUSH);
1490 ADD_INT(REG_NOTIFY_CHANGE_NAME);
1491 ADD_INT(REG_NOTIFY_CHANGE_ATTRIBUTES);
1492 ADD_INT(REG_NOTIFY_CHANGE_LAST_SET);
1493 ADD_INT(REG_NOTIFY_CHANGE_SECURITY);
1494 ADD_INT(REG_LEGAL_CHANGE_FILTER);
1495 ADD_INT(REG_NONE);
1496 ADD_INT(REG_SZ);
1497 ADD_INT(REG_EXPAND_SZ);
1498 ADD_INT(REG_BINARY);
1499 ADD_INT(REG_DWORD);
1500 ADD_INT(REG_DWORD_LITTLE_ENDIAN);
1501 ADD_INT(REG_DWORD_BIG_ENDIAN);
1502 ADD_INT(REG_LINK);
1503 ADD_INT(REG_MULTI_SZ);
1504 ADD_INT(REG_RESOURCE_LIST);
1505 ADD_INT(REG_FULL_RESOURCE_DESCRIPTOR);
1506 ADD_INT(REG_RESOURCE_REQUIREMENTS_LIST);
1507}
1508