blob: 57fe22b7561dfc932d4c1f5495aba534b9e1aaa8 [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 */
Kristján Valur Jónsson629ec262007-05-26 19:31:39 +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.
Mark Dickinson3e4caeb2009-02-21 20:27:01 +000028 Hopefully it will one day, and in the meantime I don't
Guido van Rossum9f3712c2000-03-28 20:37:15 +000029 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"
Christian Heimesb39a7562008-01-08 15:46:10 +000050"ExpandEnvironmentStrings() - Expand the env strings in a REG_EXPAND_SZ string.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +000051"FlushKey() - Writes all the attributes of the specified key to the registry.\n"
52"LoadKey() - Creates a subkey under HKEY_USER or HKEY_LOCAL_MACHINE and stores\n"
53" registration information from a specified file into that subkey.\n"
54"OpenKey() - Alias for <om win32api.RegOpenKeyEx>\n"
55"OpenKeyEx() - Opens the specified key.\n"
56"QueryValue() - Retrieves the value associated with the unnamed value for a\n"
57" specified key in the registry.\n"
58"QueryValueEx() - Retrieves the type and data for a specified value name\n"
59" associated with an open registry key.\n"
60"QueryInfoKey() - Returns information about the specified key.\n"
61"SaveKey() - Saves the specified key, and all its subkeys a file.\n"
62"SetValue() - Associates a value with a specified key.\n"
63"SetValueEx() - Stores data in the value field of an open registry key.\n"
64"\n"
65"Special objects:\n"
66"\n"
67"HKEYType -- type object for HKEY objects\n"
68"error -- exception raised for Win32 errors\n"
69"\n"
70"Integer constants:\n"
71"Many constants are defined - see the documentation for each function\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000072"to see what constants are used, and where.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000073
74
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000075PyDoc_STRVAR(CloseKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000076"CloseKey(hkey) - Closes a previously opened registry key.\n"
77"\n"
78"The hkey argument specifies a previously opened key.\n"
79"\n"
80"Note that if the key is not closed using this method, it will be\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000081"closed when the hkey object is destroyed by Python.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000082
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000083PyDoc_STRVAR(ConnectRegistry_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000084"key = ConnectRegistry(computer_name, key) - "
85"Establishes a connection to a predefined registry handle on another computer.\n"
86"\n"
87"computer_name is the name of the remote computer, of the form \\\\computername.\n"
88" If None, the local computer is used.\n"
89"key is the predefined handle to connect to.\n"
90"\n"
91"The return value is the handle of the opened key.\n"
Brian Curtine33fa882010-04-02 21:18:14 +000092"If the function fails, a WindowsError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000093
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000094PyDoc_STRVAR(CreateKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000095"key = CreateKey(key, sub_key) - Creates or opens the specified key.\n"
96"\n"
97"key is an already open key, or one of the predefined HKEY_* constants\n"
98"sub_key is a string that names the key this method opens or creates.\n"
99" If key is one of the predefined keys, sub_key may be None. In that case,\n"
100" the handle returned is the same key handle passed in to the function.\n"
101"\n"
102"If the key already exists, this function opens the existing key\n"
103"\n"
104"The return value is the handle of the opened key.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000105"If the function fails, an exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000106
Brian Curtine33fa882010-04-02 21:18:14 +0000107PyDoc_STRVAR(CreateKeyEx_doc,
108"key = CreateKeyEx(key, sub_key, res, sam) - Creates or opens the specified key.\n"
109"\n"
110"key is an already open key, or one of the predefined HKEY_* constants\n"
111"sub_key is a string that names the key this method opens or creates.\n"
112"res is a reserved integer, and must be zero. Default is zero.\n"
113"sam is an integer that specifies an access mask that describes the desired\n"
114" If key is one of the predefined keys, sub_key may be None. In that case,\n"
115" the handle returned is the same key handle passed in to the function.\n"
116"\n"
117"If the key already exists, this function opens the existing key\n"
118"\n"
119"The return value is the handle of the opened key.\n"
120"If the function fails, an exception is raised.");
121
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000122PyDoc_STRVAR(DeleteKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000123"DeleteKey(key, sub_key) - Deletes the specified key.\n"
124"\n"
125"key is an already open key, or any one of the predefined HKEY_* constants.\n"
126"sub_key is a string that must be a subkey of the key identified by the key parameter.\n"
127" This value must not be None, and the key may not have subkeys.\n"
128"\n"
129"This method can not delete keys with subkeys.\n"
130"\n"
131"If the method succeeds, the entire key, including all of its values,\n"
Brian Curtine33fa882010-04-02 21:18:14 +0000132"is removed. If the method fails, a WindowsError exception is raised.");
133
134PyDoc_STRVAR(DeleteKeyEx_doc,
135"DeleteKeyEx(key, sub_key, sam, res) - Deletes the specified key.\n"
136"\n"
137"key is an already open key, or any one of the predefined HKEY_* constants.\n"
138"sub_key is a string that must be a subkey of the key identified by the key parameter.\n"
139"res is a reserved integer, and must be zero. Default is zero.\n"
140"sam is an integer that specifies an access mask that describes the desired\n"
141" This value must not be None, and the key may not have subkeys.\n"
142"\n"
143"This method can not delete keys with subkeys.\n"
144"\n"
145"If the method succeeds, the entire key, including all of its values,\n"
146"is removed. If the method fails, a WindowsError exception is raised.\n"
147"On unsupported Windows versions, NotImplementedError is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000148
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000149PyDoc_STRVAR(DeleteValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000150"DeleteValue(key, value) - Removes a named value from a registry key.\n"
151"\n"
152"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000153"value is a string that identifies the value to remove.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000154
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000155PyDoc_STRVAR(EnumKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000156"string = EnumKey(key, index) - Enumerates subkeys of an open registry key.\n"
157"\n"
158"key is an already open key, or any one of the predefined HKEY_* constants.\n"
159"index is an integer that identifies the index of the key to retrieve.\n"
160"\n"
161"The function retrieves the name of one subkey each time it is called.\n"
Brian Curtine33fa882010-04-02 21:18:14 +0000162"It is typically called repeatedly until a WindowsError exception is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000163"raised, indicating no more values are available.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000164
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000165PyDoc_STRVAR(EnumValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000166"tuple = EnumValue(key, index) - Enumerates values of an open registry key.\n"
167"key is an already open key, or any one of the predefined HKEY_* constants.\n"
168"index is an integer that identifies the index of the value to retrieve.\n"
169"\n"
170"The function retrieves the name of one subkey each time it is called.\n"
Brian Curtine33fa882010-04-02 21:18:14 +0000171"It is typically called repeatedly, until a WindowsError exception\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000172"is raised, indicating no more values.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000173"\n"
174"The result is a tuple of 3 items:\n"
175"value_name is a string that identifies the value.\n"
176"value_data is an object that holds the value data, and whose type depends\n"
177" on the underlying registry type.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000178"data_type is an integer that identifies the type of the value data.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000179
Christian Heimesb39a7562008-01-08 15:46:10 +0000180PyDoc_STRVAR(ExpandEnvironmentStrings_doc,
181"string = ExpandEnvironmentStrings(string) - Expand environment vars.\n");
182
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000183PyDoc_STRVAR(FlushKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000184"FlushKey(key) - Writes all the attributes of a key to the registry.\n"
185"\n"
186"key is an already open key, or any one of the predefined HKEY_* constants.\n"
187"\n"
188"It is not necessary to call RegFlushKey to change a key.\n"
189"Registry changes are flushed to disk by the registry using its lazy flusher.\n"
190"Registry changes are also flushed to disk at system shutdown.\n"
191"Unlike CloseKey(), the FlushKey() method returns only when all the data has\n"
192"been written to the registry.\n"
193"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 +0000194"If you don't know whether a FlushKey() call is required, it probably isn't.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000195
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000196PyDoc_STRVAR(LoadKey_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000197"LoadKey(key, sub_key, file_name) - Creates a subkey under the specified key\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000198"and stores registration information from a specified file into that subkey.\n"
199"\n"
200"key is an already open key, or any one of the predefined HKEY_* constants.\n"
201"sub_key is a string that identifies the sub_key to load\n"
202"file_name is the name of the file to load registry data from.\n"
203" This file must have been created with the SaveKey() function.\n"
204" Under the file allocation table (FAT) file system, the filename may not\n"
205"have an extension.\n"
206"\n"
207"A call to LoadKey() fails if the calling process does not have the\n"
208"SE_RESTORE_PRIVILEGE privilege.\n"
209"\n"
210"If key is a handle returned by ConnectRegistry(), then the path specified\n"
211"in fileName is relative to the remote computer.\n"
212"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000213"The docs imply key must be in the HKEY_USER or HKEY_LOCAL_MACHINE tree");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000214
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000215PyDoc_STRVAR(OpenKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000216"key = OpenKey(key, sub_key, res = 0, sam = KEY_READ) - Opens the specified key.\n"
217"\n"
218"key is an already open key, or any one of the predefined HKEY_* constants.\n"
219"sub_key is a string that identifies the sub_key to open\n"
220"res is a reserved integer, and must be zero. Default is zero.\n"
221"sam is an integer that specifies an access mask that describes the desired\n"
222" security access for the key. Default is KEY_READ\n"
223"\n"
224"The result is a new handle to the specified key\n"
Brian Curtine33fa882010-04-02 21:18:14 +0000225"If the function fails, a WindowsError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000226
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000227PyDoc_STRVAR(OpenKeyEx_doc, "See OpenKey()");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000228
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000229PyDoc_STRVAR(QueryInfoKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000230"tuple = QueryInfoKey(key) - Returns information about a key.\n"
231"\n"
232"key is an already open key, or any one of the predefined HKEY_* constants.\n"
233"\n"
234"The result is a tuple of 3 items:"
235"An integer that identifies the number of sub keys this key has.\n"
236"An integer that identifies the number of values this key has.\n"
237"A long integer that identifies when the key was last modified (if available)\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000238" as 100's of nanoseconds since Jan 1, 1600.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000239
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000240PyDoc_STRVAR(QueryValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000241"string = QueryValue(key, sub_key) - retrieves the unnamed value for a key.\n"
242"\n"
243"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000244"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 +0000245" is associated. If this parameter is None or empty, the function retrieves\n"
246" the value set by the SetValue() method for the key identified by key."
247"\n"
248"Values in the registry have name, type, and data components. This method\n"
249"retrieves the data for a key's first value that has a NULL name.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000250"But the underlying API call doesn't return the type, Lame Lame Lame, DONT USE THIS!!!");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000251
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000252PyDoc_STRVAR(QueryValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000253"value,type_id = QueryValueEx(key, value_name) - Retrieves the type and data for a specified value name associated with an open registry key.\n"
254"\n"
255"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000256"value_name is a string indicating the value to query");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000257
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000258PyDoc_STRVAR(SaveKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000259"SaveKey(key, file_name) - Saves the specified key, and all its subkeys to the specified file.\n"
260"\n"
261"key is an already open key, or any one of the predefined HKEY_* constants.\n"
262"file_name is the name of the file to save registry data to.\n"
263" This file cannot already exist. If this filename includes an extension,\n"
264" it cannot be used on file allocation table (FAT) file systems by the\n"
265" LoadKey(), ReplaceKey() or RestoreKey() methods.\n"
266"\n"
267"If key represents a key on a remote computer, the path described by\n"
268"file_name is relative to the remote computer.\n"
269"The caller of this method must possess the SeBackupPrivilege security privilege.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000270"This function passes NULL for security_attributes to the API.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000271
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000272PyDoc_STRVAR(SetValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000273"SetValue(key, sub_key, type, value) - Associates a value with a specified key.\n"
274"\n"
275"key is an already open key, or any one of the predefined HKEY_* constants.\n"
276"sub_key is a string that names the subkey with which the value is associated.\n"
277"type is an integer that specifies the type of the data. Currently this\n"
278" must be REG_SZ, meaning only strings are supported.\n"
279"value is a string that specifies the new value.\n"
280"\n"
281"If the key specified by the sub_key parameter does not exist, the SetValue\n"
282"function creates it.\n"
283"\n"
284"Value lengths are limited by available memory. Long values (more than\n"
285"2048 bytes) should be stored as files with the filenames stored in \n"
286"the configuration registry. This helps the registry perform efficiently.\n"
287"\n"
288"The key identified by the key parameter must have been opened with\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000289"KEY_SET_VALUE access.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000290
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000291PyDoc_STRVAR(SetValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000292"SetValueEx(key, value_name, reserved, type, value) - Stores data in the value field of an open registry key.\n"
293"\n"
294"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondc9083b62003-01-15 23:38:15 +0000295"value_name is a string containing the name of the value to set, or None\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000296"type is an integer that specifies the type of the data. This should be one of:\n"
297" REG_BINARY -- Binary data in any form.\n"
298" REG_DWORD -- A 32-bit number.\n"
299" REG_DWORD_LITTLE_ENDIAN -- A 32-bit number in little-endian format.\n"
300" REG_DWORD_BIG_ENDIAN -- A 32-bit number in big-endian format.\n"
301" REG_EXPAND_SZ -- A null-terminated string that contains unexpanded references\n"
302" to environment variables (for example, %PATH%).\n"
303" REG_LINK -- A Unicode symbolic link.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000304" REG_MULTI_SZ -- An sequence of null-terminated strings, terminated by\n"
305" two null characters. Note that Python handles this\n"
306" termination automatically.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000307" REG_NONE -- No defined value type.\n"
308" REG_RESOURCE_LIST -- A device-driver resource list.\n"
309" REG_SZ -- A null-terminated string.\n"
310"reserved can be anything - zero is always passed to the API.\n"
311"value is a string that specifies the new value.\n"
312"\n"
313"This method can also set additional value and type information for the\n"
314"specified key. The key identified by the key parameter must have been\n"
315"opened with KEY_SET_VALUE access.\n"
316"\n"
317"To open the key, use the CreateKeyEx() or OpenKeyEx() methods.\n"
318"\n"
319"Value lengths are limited by available memory. Long values (more than\n"
320"2048 bytes) should be stored as files with the filenames stored in \n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000321"the configuration registry. This helps the registry perform efficiently.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000322
Mark Hammond8a3c8712008-04-06 01:42:06 +0000323PyDoc_STRVAR(DisableReflectionKey_doc,
Andrew M. Kuchlingeba00042008-04-08 01:33:10 +0000324"Disables registry reflection for 32-bit processes running on a 64-bit\n"
Mark Hammond8a3c8712008-04-06 01:42:06 +0000325"Operating System. Will generally raise NotImplemented if executed on\n"
Andrew M. Kuchlingeba00042008-04-08 01:33:10 +0000326"a 32-bit Operating System.\n"
Mark Hammond8a3c8712008-04-06 01:42:06 +0000327"If the key is not on the reflection list, the function succeeds but has no effect.\n"
328"Disabling reflection for a key does not affect reflection of any subkeys.");
329
330PyDoc_STRVAR(EnableReflectionKey_doc,
331"Restores registry reflection for the specified disabled key.\n"
Andrew M. Kuchlingeba00042008-04-08 01:33:10 +0000332"Will generally raise NotImplemented if executed on a 32-bit Operating System.\n"
Mark Hammond8a3c8712008-04-06 01:42:06 +0000333"Restoring reflection for a key does not affect reflection of any subkeys.");
334
335PyDoc_STRVAR(QueryReflectionKey_doc,
336"bool = QueryReflectionKey(hkey) - Determines the reflection state for the specified key.\n"
Andrew M. Kuchlingeba00042008-04-08 01:33:10 +0000337"Will generally raise NotImplemented if executed on a 32-bit Operating System.\n");
Mark Hammond8a3c8712008-04-06 01:42:06 +0000338
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000339/* PyHKEY docstrings */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000340PyDoc_STRVAR(PyHKEY_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000341"PyHKEY Object - A Python object, representing a win32 registry key.\n"
342"\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000343"This object wraps a Windows HKEY object, automatically closing it when\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000344"the object is destroyed. To guarantee cleanup, you can call either\n"
345"the Close() method on the PyHKEY, or the CloseKey() method.\n"
346"\n"
347"All functions which accept a handle object also accept an integer - \n"
348"however, use of the handle object is encouraged.\n"
349"\n"
350"Functions:\n"
351"Close() - Closes the underlying handle.\n"
352"Detach() - Returns the integer Win32 handle, detaching it from the object\n"
353"\n"
354"Properties:\n"
355"handle - The integer Win32 handle.\n"
356"\n"
357"Operations:\n"
358"__nonzero__ - Handles with an open object return true, otherwise false.\n"
359"__int__ - Converting a handle to an integer returns the Win32 handle.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000360"__cmp__ - Handle objects are compared using the handle value.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000361
362
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000363PyDoc_STRVAR(PyHKEY_Close_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000364"key.Close() - Closes the underlying Windows handle.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000365"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000366"If the handle is already closed, no error is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000367
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000368PyDoc_STRVAR(PyHKEY_Detach_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000369"int = key.Detach() - Detaches the Windows handle from the handle object.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000370"\n"
371"The result is the value of the handle before it is detached. If the\n"
372"handle is already detached, this will return zero.\n"
373"\n"
374"After calling this function, the handle is effectively invalidated,\n"
375"but the handle is not closed. You would call this function when you\n"
376"need the underlying win32 handle to exist beyond the lifetime of the\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000377"handle object.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000378"On 64 bit windows, the result of this function is a long integer");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000379
380
381/************************************************************************
382
383 The PyHKEY object definition
384
385************************************************************************/
386typedef struct {
387 PyObject_VAR_HEAD
388 HKEY hkey;
389} PyHKEYObject;
390
391#define PyHKEY_Check(op) ((op)->ob_type == &PyHKEY_Type)
392
393static char *failMsg = "bad operand type";
394
395static PyObject *
396PyHKEY_unaryFailureFunc(PyObject *ob)
397{
398 PyErr_SetString(PyExc_TypeError, failMsg);
399 return NULL;
400}
401static PyObject *
402PyHKEY_binaryFailureFunc(PyObject *ob1, PyObject *ob2)
403{
404 PyErr_SetString(PyExc_TypeError, failMsg);
405 return NULL;
406}
407static PyObject *
408PyHKEY_ternaryFailureFunc(PyObject *ob1, PyObject *ob2, PyObject *ob3)
409{
410 PyErr_SetString(PyExc_TypeError, failMsg);
411 return NULL;
412}
413
414static void
415PyHKEY_deallocFunc(PyObject *ob)
416{
417 /* Can not call PyHKEY_Close, as the ob->tp_type
418 has already been cleared, thus causing the type
419 check to fail!
420 */
421 PyHKEYObject *obkey = (PyHKEYObject *)ob;
422 if (obkey->hkey)
423 RegCloseKey((HKEY)obkey->hkey);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000424 PyObject_DEL(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000425}
426
427static int
428PyHKEY_nonzeroFunc(PyObject *ob)
429{
430 return ((PyHKEYObject *)ob)->hkey != 0;
431}
432
433static PyObject *
434PyHKEY_intFunc(PyObject *ob)
435{
436 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
437 return PyLong_FromVoidPtr(pyhkey->hkey);
438}
439
440static int
441PyHKEY_printFunc(PyObject *ob, FILE *fp, int flags)
442{
Amaury Forgeot d'Arca18392a2009-01-13 23:19:08 +0000443 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
444 fprintf(fp, "<PyHKEY at %p (%p)>",
445 ob, pyhkey->hkey);
446 return 0;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000447}
448
449static PyObject *
450PyHKEY_strFunc(PyObject *ob)
451{
Amaury Forgeot d'Arca18392a2009-01-13 23:19:08 +0000452 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
453 return PyString_FromFormat("<PyHKEY:%p>", pyhkey->hkey);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000454}
455
456static int
457PyHKEY_compareFunc(PyObject *ob1, PyObject *ob2)
458{
459 PyHKEYObject *pyhkey1 = (PyHKEYObject *)ob1;
460 PyHKEYObject *pyhkey2 = (PyHKEYObject *)ob2;
461 return pyhkey1 == pyhkey2 ? 0 :
462 (pyhkey1 < pyhkey2 ? -1 : 1);
463}
464
465static long
466PyHKEY_hashFunc(PyObject *ob)
467{
468 /* Just use the address.
469 XXX - should we use the handle value?
470 */
Fred Drake13634cf2000-06-29 19:17:04 +0000471 return _Py_HashPointer(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000472}
473
474
475static PyNumberMethods PyHKEY_NumberMethods =
476{
477 PyHKEY_binaryFailureFunc, /* nb_add */
478 PyHKEY_binaryFailureFunc, /* nb_subtract */
479 PyHKEY_binaryFailureFunc, /* nb_multiply */
480 PyHKEY_binaryFailureFunc, /* nb_divide */
481 PyHKEY_binaryFailureFunc, /* nb_remainder */
482 PyHKEY_binaryFailureFunc, /* nb_divmod */
483 PyHKEY_ternaryFailureFunc, /* nb_power */
484 PyHKEY_unaryFailureFunc, /* nb_negative */
485 PyHKEY_unaryFailureFunc, /* nb_positive */
486 PyHKEY_unaryFailureFunc, /* nb_absolute */
487 PyHKEY_nonzeroFunc, /* nb_nonzero */
488 PyHKEY_unaryFailureFunc, /* nb_invert */
489 PyHKEY_binaryFailureFunc, /* nb_lshift */
490 PyHKEY_binaryFailureFunc, /* nb_rshift */
491 PyHKEY_binaryFailureFunc, /* nb_and */
492 PyHKEY_binaryFailureFunc, /* nb_xor */
493 PyHKEY_binaryFailureFunc, /* nb_or */
494 0, /* nb_coerce (allowed to be zero) */
495 PyHKEY_intFunc, /* nb_int */
496 PyHKEY_unaryFailureFunc, /* nb_long */
497 PyHKEY_unaryFailureFunc, /* nb_float */
498 PyHKEY_unaryFailureFunc, /* nb_oct */
499 PyHKEY_unaryFailureFunc, /* nb_hex */
500};
501
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +0000502static PyObject *PyHKEY_CloseMethod(PyObject *self, PyObject *args);
503static PyObject *PyHKEY_DetachMethod(PyObject *self, PyObject *args);
504static PyObject *PyHKEY_Enter(PyObject *self);
505static PyObject *PyHKEY_Exit(PyObject *self, PyObject *args);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000506
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +0000507static struct PyMethodDef PyHKEY_methods[] = {
508 {"Close", PyHKEY_CloseMethod, METH_VARARGS, PyHKEY_Close_doc},
509 {"Detach", PyHKEY_DetachMethod, METH_VARARGS, PyHKEY_Detach_doc},
510 {"__enter__", (PyCFunction)PyHKEY_Enter, METH_NOARGS, NULL},
511 {"__exit__", PyHKEY_Exit, METH_VARARGS, NULL},
512 {NULL}
513};
514
515static PyMemberDef PyHKEY_memberlist[] = {
516 {"handle", T_PYSSIZET, offsetof(PyHKEYObject, hkey), READONLY},
517 {NULL} /* Sentinel */
518};
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000519
520/* The type itself */
521PyTypeObject PyHKEY_Type =
522{
Martin v. Löwis68192102007-07-21 06:55:02 +0000523 PyVarObject_HEAD_INIT(0, 0) /* fill in type at module init */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000524 "PyHKEY",
525 sizeof(PyHKEYObject),
526 0,
527 PyHKEY_deallocFunc, /* tp_dealloc */
528 PyHKEY_printFunc, /* tp_print */
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +0000529 0, /* tp_getattr */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000530 0, /* tp_setattr */
531 PyHKEY_compareFunc, /* tp_compare */
532 0, /* tp_repr */
533 &PyHKEY_NumberMethods, /* tp_as_number */
534 0, /* tp_as_sequence */
535 0, /* tp_as_mapping */
536 PyHKEY_hashFunc, /* tp_hash */
537 0, /* tp_call */
538 PyHKEY_strFunc, /* tp_str */
539 0, /* tp_getattro */
540 0, /* tp_setattro */
541 0, /* tp_as_buffer */
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +0000542 Py_TPFLAGS_DEFAULT, /* tp_flags */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000543 PyHKEY_doc, /* tp_doc */
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +0000544 0, /* tp_traverse */
545 0, /* tp_clear */
546 0, /* tp_richcompare */
547 0, /* tp_weaklistoffset */
548 0, /* tp_iter */
549 0, /* tp_iternext */
550 PyHKEY_methods, /* tp_methods */
551 PyHKEY_memberlist, /* tp_members */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000552};
553
554/************************************************************************
555
556 The PyHKEY object methods
557
558************************************************************************/
559static PyObject *
560PyHKEY_CloseMethod(PyObject *self, PyObject *args)
561{
562 if (!PyArg_ParseTuple(args, ":Close"))
563 return NULL;
564 if (!PyHKEY_Close(self))
565 return NULL;
566 Py_INCREF(Py_None);
567 return Py_None;
568}
569
570static PyObject *
571PyHKEY_DetachMethod(PyObject *self, PyObject *args)
572{
573 void* ret;
574 PyHKEYObject *pThis = (PyHKEYObject *)self;
575 if (!PyArg_ParseTuple(args, ":Detach"))
576 return NULL;
577 ret = (void*)pThis->hkey;
578 pThis->hkey = 0;
579 return PyLong_FromVoidPtr(ret);
580}
581
Christian Heimesb39a7562008-01-08 15:46:10 +0000582static PyObject *
583PyHKEY_Enter(PyObject *self)
584{
585 Py_XINCREF(self);
586 return self;
587}
588
589static PyObject *
590PyHKEY_Exit(PyObject *self, PyObject *args)
591{
592 if (!PyHKEY_Close(self))
593 return NULL;
594 Py_RETURN_NONE;
595}
596
597
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000598/************************************************************************
599 The public PyHKEY API (well, not public yet :-)
600************************************************************************/
601PyObject *
602PyHKEY_New(HKEY hInit)
603{
604 PyHKEYObject *key = PyObject_NEW(PyHKEYObject, &PyHKEY_Type);
605 if (key)
606 key->hkey = hInit;
607 return (PyObject *)key;
608}
609
610BOOL
611PyHKEY_Close(PyObject *ob_handle)
612{
613 LONG rc;
614 PyHKEYObject *key;
615
616 if (!PyHKEY_Check(ob_handle)) {
617 PyErr_SetString(PyExc_TypeError, "bad operand type");
618 return FALSE;
619 }
620 key = (PyHKEYObject *)ob_handle;
621 rc = key->hkey ? RegCloseKey((HKEY)key->hkey) : ERROR_SUCCESS;
622 key->hkey = 0;
623 if (rc != ERROR_SUCCESS)
624 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
625 return rc == ERROR_SUCCESS;
626}
627
628BOOL
629PyHKEY_AsHKEY(PyObject *ob, HKEY *pHANDLE, BOOL bNoneOK)
630{
631 if (ob == Py_None) {
632 if (!bNoneOK) {
633 PyErr_SetString(
634 PyExc_TypeError,
635 "None is not a valid HKEY in this context");
636 return FALSE;
637 }
638 *pHANDLE = (HKEY)0;
639 }
640 else if (PyHKEY_Check(ob)) {
641 PyHKEYObject *pH = (PyHKEYObject *)ob;
642 *pHANDLE = pH->hkey;
643 }
644 else if (PyInt_Check(ob) || PyLong_Check(ob)) {
645 /* We also support integers */
646 PyErr_Clear();
647 *pHANDLE = (HKEY)PyLong_AsVoidPtr(ob);
648 if (PyErr_Occurred())
649 return FALSE;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000650 }
651 else {
652 PyErr_SetString(
653 PyExc_TypeError,
654 "The object is not a PyHKEY object");
655 return FALSE;
656 }
657 return TRUE;
658}
659
660PyObject *
661PyHKEY_FromHKEY(HKEY h)
662{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000663 PyHKEYObject *op;
664
Guido van Rossume3a8e7e2002-08-19 19:26:42 +0000665 /* Inline PyObject_New */
Guido van Rossumb18618d2000-05-03 23:44:39 +0000666 op = (PyHKEYObject *) PyObject_MALLOC(sizeof(PyHKEYObject));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000667 if (op == NULL)
668 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000669 PyObject_INIT(op, &PyHKEY_Type);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000670 op->hkey = h;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000671 return (PyObject *)op;
672}
673
674
675/************************************************************************
676 The module methods
677************************************************************************/
678BOOL
679PyWinObject_CloseHKEY(PyObject *obHandle)
680{
681 BOOL ok;
682 if (PyHKEY_Check(obHandle)) {
683 ok = PyHKEY_Close(obHandle);
684 }
Fred Drake25e17262000-06-30 17:48:51 +0000685#if SIZEOF_LONG >= SIZEOF_HKEY
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000686 else if (PyInt_Check(obHandle)) {
687 long rc = RegCloseKey((HKEY)PyInt_AsLong(obHandle));
688 ok = (rc == ERROR_SUCCESS);
689 if (!ok)
690 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
691 }
Fred Drake25e17262000-06-30 17:48:51 +0000692#else
693 else if (PyLong_Check(obHandle)) {
694 long rc = RegCloseKey((HKEY)PyLong_AsVoidPtr(obHandle));
695 ok = (rc == ERROR_SUCCESS);
696 if (!ok)
697 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
698 }
699#endif
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000700 else {
701 PyErr_SetString(
702 PyExc_TypeError,
703 "A handle must be a HKEY object or an integer");
704 return FALSE;
705 }
706 return ok;
707}
708
709
710/*
711 Private Helper functions for the registry interfaces
712
713** Note that fixupMultiSZ and countString have both had changes
714** made to support "incorrect strings". The registry specification
715** calls for strings to be terminated with 2 null bytes. It seems
Mark Dickinson3e4caeb2009-02-21 20:27:01 +0000716** some commercial packages install strings which don't conform,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000717** causing this code to fail - however, "regedit" etc still work
Mark Dickinson3e4caeb2009-02-21 20:27:01 +0000718** with these strings (ie only we don't!).
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000719*/
720static void
721fixupMultiSZ(char **str, char *data, int len)
722{
723 char *P;
724 int i;
725 char *Q;
726
727 Q = data + len;
728 for (P = data, i = 0; P < Q && *P != '\0'; P++, i++) {
729 str[i] = P;
730 for(; *P != '\0'; P++)
731 ;
732 }
733}
734
735static int
736countStrings(char *data, int len)
737{
738 int strings;
739 char *P;
740 char *Q = data + len;
741
742 for (P = data, strings = 0; P < Q && *P != '\0'; P++, strings++)
743 for (; P < Q && *P != '\0'; P++)
744 ;
745 return strings;
746}
747
748/* Convert PyObject into Registry data.
749 Allocates space as needed. */
750static BOOL
751Py2Reg(PyObject *value, DWORD typ, BYTE **retDataBuf, DWORD *retDataSize)
752{
Neal Norwitz4677fbf72008-03-25 04:18:18 +0000753 Py_ssize_t i,j;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000754 switch (typ) {
755 case REG_DWORD:
756 if (value != Py_None && !PyInt_Check(value))
757 return FALSE;
Kristján Valur Jónsson17b8e972007-04-25 00:10:50 +0000758 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, 1);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000759 if (*retDataBuf==NULL){
760 PyErr_NoMemory();
761 return FALSE;
762 }
763 *retDataSize = sizeof(DWORD);
764 if (value == Py_None) {
765 DWORD zero = 0;
766 memcpy(*retDataBuf, &zero, sizeof(DWORD));
767 }
768 else
769 memcpy(*retDataBuf,
770 &PyInt_AS_LONG((PyIntObject *)value),
771 sizeof(DWORD));
772 break;
773 case REG_SZ:
774 case REG_EXPAND_SZ:
775 {
776 int need_decref = 0;
777 if (value == Py_None)
778 *retDataSize = 1;
779 else {
780 if (PyUnicode_Check(value)) {
781 value = PyUnicode_AsEncodedString(
782 value,
783 "mbcs",
784 NULL);
785 if (value==NULL)
786 return FALSE;
787 need_decref = 1;
788 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000789 if (!PyString_Check(value))
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000790 return FALSE;
791 *retDataSize = 1 + strlen(
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000792 PyString_AS_STRING(
793 (PyStringObject *)value));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000794 }
795 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, *retDataSize);
796 if (*retDataBuf==NULL){
797 PyErr_NoMemory();
798 return FALSE;
799 }
800 if (value == Py_None)
801 strcpy((char *)*retDataBuf, "");
802 else
803 strcpy((char *)*retDataBuf,
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000804 PyString_AS_STRING(
805 (PyStringObject *)value));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000806 if (need_decref)
807 Py_DECREF(value);
808 break;
809 }
810 case REG_MULTI_SZ:
811 {
812 DWORD size = 0;
813 char *P;
814 PyObject **obs = NULL;
815
816 if (value == Py_None)
817 i = 0;
818 else {
819 if (!PyList_Check(value))
820 return FALSE;
821 i = PyList_Size(value);
822 }
823 obs = malloc(sizeof(PyObject *) * i);
824 memset(obs, 0, sizeof(PyObject *) * i);
825 for (j = 0; j < i; j++)
826 {
827 PyObject *t;
828 t = PyList_GET_ITEM(
829 (PyListObject *)value,j);
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000830 if (PyString_Check(t)) {
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000831 obs[j] = t;
832 Py_INCREF(t);
833 } else if (PyUnicode_Check(t)) {
834 obs[j] = PyUnicode_AsEncodedString(
835 t,
836 "mbcs",
837 NULL);
838 if (obs[j]==NULL)
839 goto reg_multi_fail;
840 } else
841 goto reg_multi_fail;
842 size += 1 + strlen(
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000843 PyString_AS_STRING(
844 (PyStringObject *)obs[j]));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000845 }
846
847 *retDataSize = size + 1;
848 *retDataBuf = (BYTE *)PyMem_NEW(char,
849 *retDataSize);
850 if (*retDataBuf==NULL){
851 PyErr_NoMemory();
852 goto reg_multi_fail;
853 }
854 P = (char *)*retDataBuf;
855
856 for (j = 0; j < i; j++)
857 {
858 PyObject *t;
859 t = obs[j];
860 strcpy(P,
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000861 PyString_AS_STRING(
862 (PyStringObject *)t));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000863 P += 1 + strlen(
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000864 PyString_AS_STRING(
865 (PyStringObject *)t));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000866 Py_DECREF(obs[j]);
867 }
868 /* And doubly-terminate the list... */
869 *P = '\0';
870 free(obs);
871 break;
872 reg_multi_fail:
873 if (obs) {
874 for (j = 0; j < i; j++)
875 Py_XDECREF(obs[j]);
876
877 free(obs);
878 }
879 return FALSE;
880 }
881 case REG_BINARY:
882 /* ALSO handle ALL unknown data types here. Even if we can't
883 support it natively, we should handle the bits. */
884 default:
885 if (value == Py_None)
886 *retDataSize = 0;
887 else {
Mark Hammond4e80bb52000-07-28 03:44:41 +0000888 void *src_buf;
889 PyBufferProcs *pb = value->ob_type->tp_as_buffer;
890 if (pb==NULL) {
Tim Peters313fcd42006-02-19 04:05:39 +0000891 PyErr_Format(PyExc_TypeError,
Mark Hammond4e80bb52000-07-28 03:44:41 +0000892 "Objects of type '%s' can not "
Tim Peters313fcd42006-02-19 04:05:39 +0000893 "be used as binary registry values",
Mark Hammond4e80bb52000-07-28 03:44:41 +0000894 value->ob_type->tp_name);
895 return FALSE;
896 }
897 *retDataSize = (*pb->bf_getreadbuffer)(value, 0, &src_buf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000898 *retDataBuf = (BYTE *)PyMem_NEW(char,
899 *retDataSize);
900 if (*retDataBuf==NULL){
901 PyErr_NoMemory();
902 return FALSE;
903 }
Mark Hammond4e80bb52000-07-28 03:44:41 +0000904 memcpy(*retDataBuf, src_buf, *retDataSize);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000905 }
906 break;
907 }
908 return TRUE;
909}
910
911/* Convert Registry data into PyObject*/
912static PyObject *
913Reg2Py(char *retDataBuf, DWORD retDataSize, DWORD typ)
914{
915 PyObject *obData;
916
917 switch (typ) {
918 case REG_DWORD:
919 if (retDataSize == 0)
920 obData = Py_BuildValue("i", 0);
921 else
922 obData = Py_BuildValue("i",
923 *(int *)retDataBuf);
924 break;
925 case REG_SZ:
926 case REG_EXPAND_SZ:
927 /* retDataBuf may or may not have a trailing NULL in
928 the buffer. */
929 if (retDataSize && retDataBuf[retDataSize-1] == '\0')
930 --retDataSize;
931 if (retDataSize ==0)
932 retDataBuf = "";
933 obData = PyUnicode_DecodeMBCS(retDataBuf,
934 retDataSize,
935 NULL);
936 break;
937 case REG_MULTI_SZ:
938 if (retDataSize == 0)
939 obData = PyList_New(0);
940 else
941 {
942 int index = 0;
943 int s = countStrings(retDataBuf, retDataSize);
944 char **str = (char **)malloc(sizeof(char *)*s);
945 if (str == NULL)
946 return PyErr_NoMemory();
947
948 fixupMultiSZ(str, retDataBuf, retDataSize);
949 obData = PyList_New(s);
Fred Drake25e17262000-06-30 17:48:51 +0000950 if (obData == NULL)
951 return NULL;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000952 for (index = 0; index < s; index++)
953 {
Fred Drake25e17262000-06-30 17:48:51 +0000954 size_t len = _mbstrlen(str[index]);
955 if (len > INT_MAX) {
956 PyErr_SetString(PyExc_OverflowError,
957 "registry string is too long for a Python string");
958 Py_DECREF(obData);
959 return NULL;
960 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000961 PyList_SetItem(obData,
962 index,
963 PyUnicode_DecodeMBCS(
964 (const char *)str[index],
Fred Drake25e17262000-06-30 17:48:51 +0000965 (int)len,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000966 NULL)
967 );
968 }
969 free(str);
970
971 break;
972 }
973 case REG_BINARY:
974 /* ALSO handle ALL unknown data types here. Even if we can't
975 support it natively, we should handle the bits. */
976 default:
977 if (retDataSize == 0) {
978 Py_INCREF(Py_None);
979 obData = Py_None;
980 }
981 else
982 obData = Py_BuildValue("s#",
983 (char *)retDataBuf,
984 retDataSize);
985 break;
986 }
987 if (obData == NULL)
988 return NULL;
989 else
990 return obData;
991}
992
993/* The Python methods */
994
995static PyObject *
996PyCloseKey(PyObject *self, PyObject *args)
997{
998 PyObject *obKey;
999 if (!PyArg_ParseTuple(args, "O:CloseKey", &obKey))
1000 return NULL;
1001 if (!PyHKEY_Close(obKey))
1002 return NULL;
1003 Py_INCREF(Py_None);
1004 return Py_None;
1005}
1006
1007static PyObject *
1008PyConnectRegistry(PyObject *self, PyObject *args)
1009{
1010 HKEY hKey;
1011 PyObject *obKey;
1012 char *szCompName = NULL;
1013 HKEY retKey;
1014 long rc;
1015 if (!PyArg_ParseTuple(args, "zO:ConnectRegistry", &szCompName, &obKey))
1016 return NULL;
1017 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1018 return NULL;
Martin v. Löwisbda0dde2006-07-24 10:26:33 +00001019 Py_BEGIN_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001020 rc = RegConnectRegistry(szCompName, hKey, &retKey);
Martin v. Löwisbda0dde2006-07-24 10:26:33 +00001021 Py_END_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001022 if (rc != ERROR_SUCCESS)
1023 return PyErr_SetFromWindowsErrWithFunction(rc,
1024 "ConnectRegistry");
1025 return PyHKEY_FromHKEY(retKey);
1026}
1027
1028static PyObject *
1029PyCreateKey(PyObject *self, PyObject *args)
1030{
1031 HKEY hKey;
1032 PyObject *obKey;
1033 char *subKey;
1034 HKEY retKey;
1035 long rc;
1036 if (!PyArg_ParseTuple(args, "Oz:CreateKey", &obKey, &subKey))
1037 return NULL;
1038 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1039 return NULL;
1040 rc = RegCreateKey(hKey, subKey, &retKey);
1041 if (rc != ERROR_SUCCESS)
1042 return PyErr_SetFromWindowsErrWithFunction(rc, "CreateKey");
1043 return PyHKEY_FromHKEY(retKey);
1044}
1045
1046static PyObject *
Brian Curtine33fa882010-04-02 21:18:14 +00001047PyCreateKeyEx(PyObject *self, PyObject *args)
1048{
1049 HKEY hKey;
1050 PyObject *obKey;
1051 char *subKey;
1052 HKEY retKey;
1053 int res = 0;
1054 REGSAM sam = KEY_WRITE;
1055 long rc;
1056 if (!PyArg_ParseTuple(args, "Oz|ii:CreateKeyEx", &obKey, &subKey,
1057 &res, &sam))
1058 return NULL;
1059 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1060 return NULL;
1061
1062 rc = RegCreateKeyEx(hKey, subKey, res, NULL, (DWORD)NULL,
1063 sam, NULL, &retKey, NULL);
1064 if (rc != ERROR_SUCCESS)
1065 return PyErr_SetFromWindowsErrWithFunction(rc, "CreateKeyEx");
1066 return PyHKEY_FromHKEY(retKey);
1067}
1068
1069static PyObject *
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001070PyDeleteKey(PyObject *self, PyObject *args)
1071{
1072 HKEY hKey;
1073 PyObject *obKey;
1074 char *subKey;
1075 long rc;
1076 if (!PyArg_ParseTuple(args, "Os:DeleteKey", &obKey, &subKey))
1077 return NULL;
1078 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1079 return NULL;
1080 rc = RegDeleteKey(hKey, subKey );
1081 if (rc != ERROR_SUCCESS)
1082 return PyErr_SetFromWindowsErrWithFunction(rc, "RegDeleteKey");
1083 Py_INCREF(Py_None);
1084 return Py_None;
1085}
1086
1087static PyObject *
Brian Curtine33fa882010-04-02 21:18:14 +00001088PyDeleteKeyEx(PyObject *self, PyObject *args)
1089{
1090 HKEY hKey;
1091 PyObject *obKey;
1092 HMODULE hMod;
1093 typedef LONG (WINAPI *RDKEFunc)(HKEY, const char*, REGSAM, int);
1094 RDKEFunc pfn = NULL;
1095 char *subKey;
1096 long rc;
1097 int res = 0;
1098 REGSAM sam = KEY_WOW64_64KEY;
1099
1100 if (!PyArg_ParseTuple(args, "Os|ii:DeleteKeyEx",
1101 &obKey, &subKey, &sam, &res))
1102 return NULL;
1103 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1104 return NULL;
1105
1106 /* Only available on 64bit platforms, so we must load it
1107 dynamically. */
1108 hMod = GetModuleHandle("advapi32.dll");
1109 if (hMod)
1110 pfn = (RDKEFunc)GetProcAddress(hMod,
1111 "RegDeleteKeyExA");
1112 if (!pfn) {
1113 PyErr_SetString(PyExc_NotImplementedError,
1114 "not implemented on this platform");
1115 return NULL;
1116 }
1117 Py_BEGIN_ALLOW_THREADS
1118 rc = (*pfn)(hKey, subKey, sam, res);
1119 Py_END_ALLOW_THREADS
1120
1121 if (rc != ERROR_SUCCESS)
1122 return PyErr_SetFromWindowsErrWithFunction(rc, "RegDeleteKeyEx");
1123 Py_INCREF(Py_None);
1124 return Py_None;
1125}
1126
1127static PyObject *
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001128PyDeleteValue(PyObject *self, PyObject *args)
1129{
1130 HKEY hKey;
1131 PyObject *obKey;
1132 char *subKey;
1133 long rc;
1134 if (!PyArg_ParseTuple(args, "Oz:DeleteValue", &obKey, &subKey))
1135 return NULL;
1136 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1137 return NULL;
1138 Py_BEGIN_ALLOW_THREADS
1139 rc = RegDeleteValue(hKey, subKey);
1140 Py_END_ALLOW_THREADS
1141 if (rc !=ERROR_SUCCESS)
1142 return PyErr_SetFromWindowsErrWithFunction(rc,
1143 "RegDeleteValue");
1144 Py_INCREF(Py_None);
1145 return Py_None;
1146}
1147
1148static PyObject *
1149PyEnumKey(PyObject *self, PyObject *args)
1150{
1151 HKEY hKey;
1152 PyObject *obKey;
1153 int index;
1154 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001155 PyObject *retStr;
Georg Brandl9a928e72006-02-18 23:35:11 +00001156 char tmpbuf[256]; /* max key name length is 255 */
Georg Brandlb2699b22006-02-18 23:44:24 +00001157 DWORD len = sizeof(tmpbuf); /* includes NULL terminator */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001158
1159 if (!PyArg_ParseTuple(args, "Oi:EnumKey", &obKey, &index))
1160 return NULL;
1161 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1162 return NULL;
Tim Peters313fcd42006-02-19 04:05:39 +00001163
Georg Brandl9a928e72006-02-18 23:35:11 +00001164 Py_BEGIN_ALLOW_THREADS
1165 rc = RegEnumKeyEx(hKey, index, tmpbuf, &len, NULL, NULL, NULL, NULL);
1166 Py_END_ALLOW_THREADS
1167 if (rc != ERROR_SUCCESS)
1168 return PyErr_SetFromWindowsErrWithFunction(rc, "RegEnumKeyEx");
Tim Peters313fcd42006-02-19 04:05:39 +00001169
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001170 retStr = PyString_FromStringAndSize(tmpbuf, len);
Georg Brandl9a928e72006-02-18 23:35:11 +00001171 return retStr; /* can be NULL */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001172}
1173
1174static PyObject *
1175PyEnumValue(PyObject *self, PyObject *args)
1176{
1177 HKEY hKey;
1178 PyObject *obKey;
1179 int index;
1180 long rc;
1181 char *retValueBuf;
1182 char *retDataBuf;
1183 DWORD retValueSize;
1184 DWORD retDataSize;
1185 DWORD typ;
1186 PyObject *obData;
1187 PyObject *retVal;
1188
1189 if (!PyArg_ParseTuple(args, "Oi:EnumValue", &obKey, &index))
1190 return NULL;
1191 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1192 return NULL;
1193
1194 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, NULL, NULL, NULL, NULL,
1195 NULL,
1196 &retValueSize, &retDataSize, NULL, NULL))
1197 != ERROR_SUCCESS)
1198 return PyErr_SetFromWindowsErrWithFunction(rc,
1199 "RegQueryInfoKey");
1200 ++retValueSize; /* include null terminators */
1201 ++retDataSize;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001202 retValueBuf = (char *)PyMem_Malloc(retValueSize);
1203 if (retValueBuf == NULL)
1204 return PyErr_NoMemory();
1205 retDataBuf = (char *)PyMem_Malloc(retDataSize);
1206 if (retDataBuf == NULL) {
1207 PyMem_Free(retValueBuf);
1208 return PyErr_NoMemory();
1209 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001210
1211 Py_BEGIN_ALLOW_THREADS
1212 rc = RegEnumValue(hKey,
1213 index,
1214 retValueBuf,
1215 &retValueSize,
1216 NULL,
1217 &typ,
1218 (BYTE *)retDataBuf,
1219 &retDataSize);
1220 Py_END_ALLOW_THREADS
1221
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001222 if (rc != ERROR_SUCCESS) {
1223 retVal = PyErr_SetFromWindowsErrWithFunction(rc,
1224 "PyRegEnumValue");
1225 goto fail;
1226 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001227 obData = Reg2Py(retDataBuf, retDataSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001228 if (obData == NULL) {
1229 retVal = NULL;
1230 goto fail;
1231 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001232 retVal = Py_BuildValue("sOi", retValueBuf, obData, typ);
1233 Py_DECREF(obData);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001234 fail:
1235 PyMem_Free(retValueBuf);
1236 PyMem_Free(retDataBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001237 return retVal;
1238}
1239
1240static PyObject *
Christian Heimesb39a7562008-01-08 15:46:10 +00001241PyExpandEnvironmentStrings(PyObject *self, PyObject *args)
1242{
1243 Py_UNICODE *retValue = NULL;
1244 Py_UNICODE *src;
1245 DWORD retValueSize;
1246 DWORD rc;
1247 PyObject *o;
1248
1249 if (!PyArg_ParseTuple(args, "u:ExpandEnvironmentStrings", &src))
1250 return NULL;
1251
1252 retValueSize = ExpandEnvironmentStringsW(src, retValue, 0);
1253 if (retValueSize == 0) {
1254 return PyErr_SetFromWindowsErrWithFunction(retValueSize,
1255 "ExpandEnvironmentStrings");
1256 }
1257 retValue = (Py_UNICODE *)PyMem_Malloc(retValueSize * sizeof(Py_UNICODE));
1258 if (retValue == NULL) {
1259 return PyErr_NoMemory();
1260 }
1261
1262 rc = ExpandEnvironmentStringsW(src, retValue, retValueSize);
1263 if (rc == 0) {
1264 PyMem_Free(retValue);
1265 return PyErr_SetFromWindowsErrWithFunction(retValueSize,
1266 "ExpandEnvironmentStrings");
1267 }
1268 o = PyUnicode_FromUnicode(retValue, wcslen(retValue));
1269 PyMem_Free(retValue);
1270 return o;
1271}
1272
1273static PyObject *
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001274PyFlushKey(PyObject *self, PyObject *args)
1275{
1276 HKEY hKey;
1277 PyObject *obKey;
1278 long rc;
1279 if (!PyArg_ParseTuple(args, "O:FlushKey", &obKey))
1280 return NULL;
1281 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1282 return NULL;
1283 Py_BEGIN_ALLOW_THREADS
1284 rc = RegFlushKey(hKey);
1285 Py_END_ALLOW_THREADS
1286 if (rc != ERROR_SUCCESS)
1287 return PyErr_SetFromWindowsErrWithFunction(rc, "RegFlushKey");
1288 Py_INCREF(Py_None);
1289 return Py_None;
1290}
1291static PyObject *
1292PyLoadKey(PyObject *self, PyObject *args)
1293{
1294 HKEY hKey;
1295 PyObject *obKey;
1296 char *subKey;
1297 char *fileName;
1298
1299 long rc;
1300 if (!PyArg_ParseTuple(args, "Oss:LoadKey", &obKey, &subKey, &fileName))
1301 return NULL;
1302 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1303 return NULL;
1304 Py_BEGIN_ALLOW_THREADS
1305 rc = RegLoadKey(hKey, subKey, fileName );
1306 Py_END_ALLOW_THREADS
1307 if (rc != ERROR_SUCCESS)
1308 return PyErr_SetFromWindowsErrWithFunction(rc, "RegLoadKey");
1309 Py_INCREF(Py_None);
1310 return Py_None;
1311}
1312
1313static PyObject *
1314PyOpenKey(PyObject *self, PyObject *args)
1315{
1316 HKEY hKey;
1317 PyObject *obKey;
1318
1319 char *subKey;
1320 int res = 0;
1321 HKEY retKey;
1322 long rc;
1323 REGSAM sam = KEY_READ;
1324 if (!PyArg_ParseTuple(args, "Oz|ii:OpenKey", &obKey, &subKey,
1325 &res, &sam))
1326 return NULL;
1327 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1328 return NULL;
1329
1330 Py_BEGIN_ALLOW_THREADS
1331 rc = RegOpenKeyEx(hKey, subKey, res, sam, &retKey);
1332 Py_END_ALLOW_THREADS
1333 if (rc != ERROR_SUCCESS)
1334 return PyErr_SetFromWindowsErrWithFunction(rc, "RegOpenKeyEx");
1335 return PyHKEY_FromHKEY(retKey);
1336}
1337
1338
1339static PyObject *
1340PyQueryInfoKey(PyObject *self, PyObject *args)
1341{
1342 HKEY hKey;
1343 PyObject *obKey;
1344 long rc;
1345 DWORD nSubKeys, nValues;
1346 FILETIME ft;
1347 LARGE_INTEGER li;
1348 PyObject *l;
1349 PyObject *ret;
1350 if (!PyArg_ParseTuple(args, "O:QueryInfoKey", &obKey))
1351 return NULL;
1352 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1353 return NULL;
1354 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, 0, &nSubKeys, NULL, NULL,
1355 &nValues, NULL, NULL, NULL, &ft))
1356 != ERROR_SUCCESS)
1357 return PyErr_SetFromWindowsErrWithFunction(rc, "RegQueryInfoKey");
1358 li.LowPart = ft.dwLowDateTime;
1359 li.HighPart = ft.dwHighDateTime;
1360 l = PyLong_FromLongLong(li.QuadPart);
1361 if (l == NULL)
1362 return NULL;
1363 ret = Py_BuildValue("iiO", nSubKeys, nValues, l);
1364 Py_DECREF(l);
1365 return ret;
1366}
1367
1368static PyObject *
1369PyQueryValue(PyObject *self, PyObject *args)
1370{
1371 HKEY hKey;
1372 PyObject *obKey;
1373 char *subKey;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001374 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001375 PyObject *retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001376 char *retBuf;
1377 long bufSize = 0;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001378
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001379 if (!PyArg_ParseTuple(args, "Oz:QueryValue", &obKey, &subKey))
1380 return NULL;
1381
1382 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1383 return NULL;
1384 if ((rc = RegQueryValue(hKey, subKey, NULL, &bufSize))
1385 != ERROR_SUCCESS)
1386 return PyErr_SetFromWindowsErrWithFunction(rc,
1387 "RegQueryValue");
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001388 retStr = PyString_FromStringAndSize(NULL, bufSize);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001389 if (retStr == NULL)
1390 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001391 retBuf = PyString_AS_STRING(retStr);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001392 if ((rc = RegQueryValue(hKey, subKey, retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001393 != ERROR_SUCCESS) {
1394 Py_DECREF(retStr);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001395 return PyErr_SetFromWindowsErrWithFunction(rc,
1396 "RegQueryValue");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001397 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001398 _PyString_Resize(&retStr, strlen(retBuf));
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001399 return retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001400}
1401
1402static PyObject *
1403PyQueryValueEx(PyObject *self, PyObject *args)
1404{
1405 HKEY hKey;
1406 PyObject *obKey;
1407 char *valueName;
1408
1409 long rc;
1410 char *retBuf;
1411 DWORD bufSize = 0;
1412 DWORD typ;
1413 PyObject *obData;
1414 PyObject *result;
1415
1416 if (!PyArg_ParseTuple(args, "Oz:QueryValueEx", &obKey, &valueName))
1417 return NULL;
1418
1419 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1420 return NULL;
1421 if ((rc = RegQueryValueEx(hKey, valueName,
1422 NULL, NULL, NULL,
1423 &bufSize))
1424 != ERROR_SUCCESS)
1425 return PyErr_SetFromWindowsErrWithFunction(rc,
1426 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001427 retBuf = (char *)PyMem_Malloc(bufSize);
1428 if (retBuf == NULL)
1429 return PyErr_NoMemory();
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001430 if ((rc = RegQueryValueEx(hKey, valueName, NULL,
1431 &typ, (BYTE *)retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001432 != ERROR_SUCCESS) {
1433 PyMem_Free(retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001434 return PyErr_SetFromWindowsErrWithFunction(rc,
1435 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001436 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001437 obData = Reg2Py(retBuf, bufSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001438 PyMem_Free((void *)retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001439 if (obData == NULL)
1440 return NULL;
1441 result = Py_BuildValue("Oi", obData, typ);
1442 Py_DECREF(obData);
1443 return result;
1444}
1445
1446
1447static PyObject *
1448PySaveKey(PyObject *self, PyObject *args)
1449{
1450 HKEY hKey;
1451 PyObject *obKey;
1452 char *fileName;
1453 LPSECURITY_ATTRIBUTES pSA = NULL;
1454
1455 long rc;
1456 if (!PyArg_ParseTuple(args, "Os:SaveKey", &obKey, &fileName))
1457 return NULL;
1458 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1459 return NULL;
1460/* One day we may get security into the core?
1461 if (!PyWinObject_AsSECURITY_ATTRIBUTES(obSA, &pSA, TRUE))
1462 return NULL;
1463*/
1464 Py_BEGIN_ALLOW_THREADS
1465 rc = RegSaveKey(hKey, fileName, pSA );
1466 Py_END_ALLOW_THREADS
1467 if (rc != ERROR_SUCCESS)
1468 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSaveKey");
1469 Py_INCREF(Py_None);
1470 return Py_None;
1471}
1472
1473static PyObject *
1474PySetValue(PyObject *self, PyObject *args)
1475{
1476 HKEY hKey;
1477 PyObject *obKey;
1478 char *subKey;
1479 char *str;
1480 DWORD typ;
1481 DWORD len;
1482 long rc;
1483 PyObject *obStrVal;
1484 PyObject *obSubKey;
1485 if (!PyArg_ParseTuple(args, "OOiO:SetValue",
1486 &obKey,
1487 &obSubKey,
1488 &typ,
1489 &obStrVal))
1490 return NULL;
1491 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1492 return NULL;
1493 if (typ != REG_SZ) {
1494 PyErr_SetString(PyExc_TypeError,
Thomas Hellere1d18f52002-12-20 20:13:35 +00001495 "Type must be _winreg.REG_SZ");
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001496 return NULL;
1497 }
1498 /* XXX - need Unicode support */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001499 str = PyString_AsString(obStrVal);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001500 if (str == NULL)
1501 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001502 len = PyString_Size(obStrVal);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001503 if (obSubKey == Py_None)
1504 subKey = NULL;
1505 else {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001506 subKey = PyString_AsString(obSubKey);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001507 if (subKey == NULL)
1508 return NULL;
1509 }
1510 Py_BEGIN_ALLOW_THREADS
1511 rc = RegSetValue(hKey, subKey, REG_SZ, str, len+1);
1512 Py_END_ALLOW_THREADS
1513 if (rc != ERROR_SUCCESS)
1514 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSetValue");
1515 Py_INCREF(Py_None);
1516 return Py_None;
1517}
1518
1519static PyObject *
1520PySetValueEx(PyObject *self, PyObject *args)
1521{
1522 HKEY hKey;
1523 PyObject *obKey;
1524 char *valueName;
1525 PyObject *obRes;
1526 PyObject *value;
1527 BYTE *data;
1528 DWORD len;
1529 DWORD typ;
1530
1531 LONG rc;
1532
1533 if (!PyArg_ParseTuple(args, "OzOiO:SetValueEx",
1534 &obKey,
1535 &valueName,
1536 &obRes,
1537 &typ,
1538 &value))
1539 return NULL;
1540 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1541 return NULL;
1542 if (!Py2Reg(value, typ, &data, &len))
1543 {
1544 if (!PyErr_Occurred())
1545 PyErr_SetString(PyExc_ValueError,
1546 "Could not convert the data to the specified type.");
1547 return NULL;
1548 }
1549 Py_BEGIN_ALLOW_THREADS
1550 rc = RegSetValueEx(hKey, valueName, 0, typ, data, len);
1551 Py_END_ALLOW_THREADS
Guido van Rossumb18618d2000-05-03 23:44:39 +00001552 PyMem_DEL(data);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001553 if (rc != ERROR_SUCCESS)
1554 return PyErr_SetFromWindowsErrWithFunction(rc,
1555 "RegSetValueEx");
1556 Py_INCREF(Py_None);
1557 return Py_None;
1558}
1559
Mark Hammond8a3c8712008-04-06 01:42:06 +00001560static PyObject *
1561PyDisableReflectionKey(PyObject *self, PyObject *args)
1562{
1563 HKEY hKey;
1564 PyObject *obKey;
1565 HMODULE hMod;
1566 typedef LONG (WINAPI *RDRKFunc)(HKEY);
1567 RDRKFunc pfn = NULL;
1568 LONG rc;
1569
1570 if (!PyArg_ParseTuple(args, "O:DisableReflectionKey", &obKey))
1571 return NULL;
1572 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1573 return NULL;
1574
Brian Curtine33fa882010-04-02 21:18:14 +00001575 /* Only available on 64bit platforms, so we must load it
1576 dynamically. */
Mark Hammond8a3c8712008-04-06 01:42:06 +00001577 hMod = GetModuleHandle("advapi32.dll");
1578 if (hMod)
1579 pfn = (RDRKFunc)GetProcAddress(hMod,
1580 "RegDisableReflectionKey");
1581 if (!pfn) {
1582 PyErr_SetString(PyExc_NotImplementedError,
1583 "not implemented on this platform");
1584 return NULL;
1585 }
1586 Py_BEGIN_ALLOW_THREADS
1587 rc = (*pfn)(hKey);
1588 Py_END_ALLOW_THREADS
1589 if (rc != ERROR_SUCCESS)
1590 return PyErr_SetFromWindowsErrWithFunction(rc,
1591 "RegDisableReflectionKey");
1592 Py_INCREF(Py_None);
1593 return Py_None;
1594}
1595
1596static PyObject *
1597PyEnableReflectionKey(PyObject *self, PyObject *args)
1598{
1599 HKEY hKey;
1600 PyObject *obKey;
1601 HMODULE hMod;
1602 typedef LONG (WINAPI *RERKFunc)(HKEY);
1603 RERKFunc pfn = NULL;
1604 LONG rc;
1605
1606 if (!PyArg_ParseTuple(args, "O:EnableReflectionKey", &obKey))
1607 return NULL;
1608 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1609 return NULL;
1610
Brian Curtine33fa882010-04-02 21:18:14 +00001611 /* Only available on 64bit platforms, so we must load it
1612 dynamically. */
Mark Hammond8a3c8712008-04-06 01:42:06 +00001613 hMod = GetModuleHandle("advapi32.dll");
1614 if (hMod)
1615 pfn = (RERKFunc)GetProcAddress(hMod,
1616 "RegEnableReflectionKey");
1617 if (!pfn) {
1618 PyErr_SetString(PyExc_NotImplementedError,
1619 "not implemented on this platform");
1620 return NULL;
1621 }
1622 Py_BEGIN_ALLOW_THREADS
1623 rc = (*pfn)(hKey);
1624 Py_END_ALLOW_THREADS
1625 if (rc != ERROR_SUCCESS)
1626 return PyErr_SetFromWindowsErrWithFunction(rc,
1627 "RegEnableReflectionKey");
1628 Py_INCREF(Py_None);
1629 return Py_None;
1630}
1631
1632static PyObject *
1633PyQueryReflectionKey(PyObject *self, PyObject *args)
1634{
1635 HKEY hKey;
1636 PyObject *obKey;
1637 HMODULE hMod;
1638 typedef LONG (WINAPI *RQRKFunc)(HKEY, BOOL *);
1639 RQRKFunc pfn = NULL;
1640 BOOL result;
1641 LONG rc;
1642
1643 if (!PyArg_ParseTuple(args, "O:QueryReflectionKey", &obKey))
1644 return NULL;
1645 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1646 return NULL;
1647
Brian Curtine33fa882010-04-02 21:18:14 +00001648 /* Only available on 64bit platforms, so we must load it
1649 dynamically. */
Mark Hammond8a3c8712008-04-06 01:42:06 +00001650 hMod = GetModuleHandle("advapi32.dll");
1651 if (hMod)
1652 pfn = (RQRKFunc)GetProcAddress(hMod,
1653 "RegQueryReflectionKey");
1654 if (!pfn) {
1655 PyErr_SetString(PyExc_NotImplementedError,
1656 "not implemented on this platform");
1657 return NULL;
1658 }
1659 Py_BEGIN_ALLOW_THREADS
1660 rc = (*pfn)(hKey, &result);
1661 Py_END_ALLOW_THREADS
1662 if (rc != ERROR_SUCCESS)
1663 return PyErr_SetFromWindowsErrWithFunction(rc,
1664 "RegQueryReflectionKey");
Brian Curtine33fa882010-04-02 21:18:14 +00001665 return PyBool_FromLong(result);
Mark Hammond8a3c8712008-04-06 01:42:06 +00001666}
1667
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001668static struct PyMethodDef winreg_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001669 {"CloseKey", PyCloseKey, METH_VARARGS, CloseKey_doc},
1670 {"ConnectRegistry", PyConnectRegistry, METH_VARARGS, ConnectRegistry_doc},
1671 {"CreateKey", PyCreateKey, METH_VARARGS, CreateKey_doc},
Brian Curtine33fa882010-04-02 21:18:14 +00001672 {"CreateKeyEx", PyCreateKeyEx, METH_VARARGS, CreateKeyEx_doc},
Neal Norwitz031829d2002-03-31 14:37:44 +00001673 {"DeleteKey", PyDeleteKey, METH_VARARGS, DeleteKey_doc},
Brian Curtine33fa882010-04-02 21:18:14 +00001674 {"DeleteKeyEx", PyDeleteKeyEx, METH_VARARGS, DeleteKeyEx_doc},
Neal Norwitz031829d2002-03-31 14:37:44 +00001675 {"DeleteValue", PyDeleteValue, METH_VARARGS, DeleteValue_doc},
Mark Hammond8a3c8712008-04-06 01:42:06 +00001676 {"DisableReflectionKey", PyDisableReflectionKey, METH_VARARGS, DisableReflectionKey_doc},
1677 {"EnableReflectionKey", PyEnableReflectionKey, METH_VARARGS, EnableReflectionKey_doc},
Neal Norwitz031829d2002-03-31 14:37:44 +00001678 {"EnumKey", PyEnumKey, METH_VARARGS, EnumKey_doc},
1679 {"EnumValue", PyEnumValue, METH_VARARGS, EnumValue_doc},
Christian Heimesb39a7562008-01-08 15:46:10 +00001680 {"ExpandEnvironmentStrings", PyExpandEnvironmentStrings, METH_VARARGS,
1681 ExpandEnvironmentStrings_doc },
Neal Norwitz031829d2002-03-31 14:37:44 +00001682 {"FlushKey", PyFlushKey, METH_VARARGS, FlushKey_doc},
1683 {"LoadKey", PyLoadKey, METH_VARARGS, LoadKey_doc},
1684 {"OpenKey", PyOpenKey, METH_VARARGS, OpenKey_doc},
1685 {"OpenKeyEx", PyOpenKey, METH_VARARGS, OpenKeyEx_doc},
1686 {"QueryValue", PyQueryValue, METH_VARARGS, QueryValue_doc},
1687 {"QueryValueEx", PyQueryValueEx, METH_VARARGS, QueryValueEx_doc},
1688 {"QueryInfoKey", PyQueryInfoKey, METH_VARARGS, QueryInfoKey_doc},
Mark Hammond8a3c8712008-04-06 01:42:06 +00001689 {"QueryReflectionKey",PyQueryReflectionKey,METH_VARARGS, QueryReflectionKey_doc},
Neal Norwitz031829d2002-03-31 14:37:44 +00001690 {"SaveKey", PySaveKey, METH_VARARGS, SaveKey_doc},
1691 {"SetValue", PySetValue, METH_VARARGS, SetValue_doc},
1692 {"SetValueEx", PySetValueEx, METH_VARARGS, SetValueEx_doc},
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001693 NULL,
1694};
1695
1696static void
1697insint(PyObject * d, char * name, long value)
1698{
1699 PyObject *v = PyInt_FromLong(value);
1700 if (!v || PyDict_SetItemString(d, name, v))
1701 PyErr_Clear();
1702 Py_XDECREF(v);
1703}
1704
1705#define ADD_INT(val) insint(d, #val, val)
1706
1707static void
1708inskey(PyObject * d, char * name, HKEY key)
1709{
1710 PyObject *v = PyLong_FromVoidPtr(key);
1711 if (!v || PyDict_SetItemString(d, name, v))
1712 PyErr_Clear();
1713 Py_XDECREF(v);
1714}
1715
1716#define ADD_KEY(val) inskey(d, #val, val)
1717
Mark Hammond8235ea12002-07-19 06:55:41 +00001718PyMODINIT_FUNC init_winreg(void)
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001719{
1720 PyObject *m, *d;
Fred Drake270e19b2000-06-29 16:14:14 +00001721 m = Py_InitModule3("_winreg", winreg_methods, module_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001722 if (m == NULL)
1723 return;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001724 d = PyModule_GetDict(m);
Amaury Forgeot d'Arc901f2002009-06-09 23:08:13 +00001725 if (PyType_Ready(&PyHKEY_Type) < 0)
1726 return;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001727 PyHKEY_Type.tp_doc = PyHKEY_doc;
1728 Py_INCREF(&PyHKEY_Type);
1729 if (PyDict_SetItemString(d, "HKEYType",
1730 (PyObject *)&PyHKEY_Type) != 0)
1731 return;
1732 Py_INCREF(PyExc_WindowsError);
1733 if (PyDict_SetItemString(d, "error",
1734 PyExc_WindowsError) != 0)
1735 return;
1736
1737 /* Add the relevant constants */
1738 ADD_KEY(HKEY_CLASSES_ROOT);
1739 ADD_KEY(HKEY_CURRENT_USER);
1740 ADD_KEY(HKEY_LOCAL_MACHINE);
1741 ADD_KEY(HKEY_USERS);
1742 ADD_KEY(HKEY_PERFORMANCE_DATA);
1743#ifdef HKEY_CURRENT_CONFIG
1744 ADD_KEY(HKEY_CURRENT_CONFIG);
1745#endif
1746#ifdef HKEY_DYN_DATA
1747 ADD_KEY(HKEY_DYN_DATA);
1748#endif
1749 ADD_INT(KEY_QUERY_VALUE);
1750 ADD_INT(KEY_SET_VALUE);
1751 ADD_INT(KEY_CREATE_SUB_KEY);
1752 ADD_INT(KEY_ENUMERATE_SUB_KEYS);
1753 ADD_INT(KEY_NOTIFY);
1754 ADD_INT(KEY_CREATE_LINK);
1755 ADD_INT(KEY_READ);
1756 ADD_INT(KEY_WRITE);
1757 ADD_INT(KEY_EXECUTE);
1758 ADD_INT(KEY_ALL_ACCESS);
Mark Hammond8a3c8712008-04-06 01:42:06 +00001759#ifdef KEY_WOW64_64KEY
1760 ADD_INT(KEY_WOW64_64KEY);
1761#endif
1762#ifdef KEY_WOW64_32KEY
1763 ADD_INT(KEY_WOW64_32KEY);
1764#endif
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001765 ADD_INT(REG_OPTION_RESERVED);
1766 ADD_INT(REG_OPTION_NON_VOLATILE);
1767 ADD_INT(REG_OPTION_VOLATILE);
1768 ADD_INT(REG_OPTION_CREATE_LINK);
1769 ADD_INT(REG_OPTION_BACKUP_RESTORE);
1770 ADD_INT(REG_OPTION_OPEN_LINK);
1771 ADD_INT(REG_LEGAL_OPTION);
1772 ADD_INT(REG_CREATED_NEW_KEY);
1773 ADD_INT(REG_OPENED_EXISTING_KEY);
1774 ADD_INT(REG_WHOLE_HIVE_VOLATILE);
1775 ADD_INT(REG_REFRESH_HIVE);
1776 ADD_INT(REG_NO_LAZY_FLUSH);
1777 ADD_INT(REG_NOTIFY_CHANGE_NAME);
1778 ADD_INT(REG_NOTIFY_CHANGE_ATTRIBUTES);
1779 ADD_INT(REG_NOTIFY_CHANGE_LAST_SET);
1780 ADD_INT(REG_NOTIFY_CHANGE_SECURITY);
1781 ADD_INT(REG_LEGAL_CHANGE_FILTER);
1782 ADD_INT(REG_NONE);
1783 ADD_INT(REG_SZ);
1784 ADD_INT(REG_EXPAND_SZ);
1785 ADD_INT(REG_BINARY);
1786 ADD_INT(REG_DWORD);
1787 ADD_INT(REG_DWORD_LITTLE_ENDIAN);
1788 ADD_INT(REG_DWORD_BIG_ENDIAN);
1789 ADD_INT(REG_LINK);
1790 ADD_INT(REG_MULTI_SZ);
1791 ADD_INT(REG_RESOURCE_LIST);
1792 ADD_INT(REG_FULL_RESOURCE_DESCRIPTOR);
1793 ADD_INT(REG_RESOURCE_REQUIREMENTS_LIST);
1794}
1795