Georg Brandl | 38feaf0 | 2008-05-25 07:45:51 +0000 | [diff] [blame] | 1 | :mod:`winreg` -- Windows registry access |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2 | ========================================= |
| 3 | |
Georg Brandl | 38feaf0 | 2008-05-25 07:45:51 +0000 | [diff] [blame] | 4 | .. module:: winreg |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 5 | :platform: Windows |
| 6 | :synopsis: Routines and objects for manipulating the Windows registry. |
| 7 | .. sectionauthor:: Mark Hammond <MarkH@ActiveState.com> |
| 8 | |
| 9 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | These functions expose the Windows registry API to Python. Instead of using an |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 11 | integer as the registry handle, a :ref:`handle object <handle-object>` is used |
| 12 | to ensure that the handles are closed correctly, even if the programmer neglects |
| 13 | to explicitly close them. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 15 | This module offers the following functions: |
| 16 | |
| 17 | |
| 18 | .. function:: CloseKey(hkey) |
| 19 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 20 | Closes a previously opened registry key. The *hkey* argument specifies a |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 21 | previously opened key. |
| 22 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 23 | .. note:: |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 24 | |
| 25 | If *hkey* is not closed using this method (or via :meth:`hkey.Close() |
| 26 | <PyHKEY.Close>`), it is closed when the *hkey* object is destroyed by |
| 27 | Python. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 | |
| 29 | |
| 30 | .. function:: ConnectRegistry(computer_name, key) |
| 31 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 32 | Establishes a connection to a predefined registry handle on another computer, |
| 33 | and returns a :ref:`handle object <handle-object>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 34 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 35 | *computer_name* is the name of the remote computer, of the form |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 36 | ``r"\\computername"``. If ``None``, the local computer is used. |
| 37 | |
| 38 | *key* is the predefined handle to connect to. |
| 39 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 40 | The return value is the handle of the opened key. If the function fails, a |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 41 | :exc:`OSError` exception is raised. |
| 42 | |
| 43 | .. versionchanged:: 3.3 |
| 44 | This function used to raise a :exc:`WindowsError`, which is now an |
| 45 | alias of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 46 | |
| 47 | |
| 48 | .. function:: CreateKey(key, sub_key) |
| 49 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 50 | Creates or opens the specified key, returning a |
| 51 | :ref:`handle object <handle-object>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 52 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 53 | *key* is an already open key, or one of the predefined |
| 54 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 55 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 56 | *sub_key* is a string that names the key this method opens or creates. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 57 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 58 | If *key* is one of the predefined keys, *sub_key* may be ``None``. In that |
| 59 | case, the handle returned is the same key handle passed in to the function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 60 | |
| 61 | If the key already exists, this function opens the existing key. |
| 62 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 63 | The return value is the handle of the opened key. If the function fails, a |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 64 | :exc:`OSError` exception is raised. |
| 65 | |
| 66 | .. versionchanged:: 3.3 |
| 67 | This function used to raise a :exc:`WindowsError`, which is now an |
| 68 | alias of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 69 | |
| 70 | |
Brian Curtin | 1771b54 | 2010-09-27 17:56:36 +0000 | [diff] [blame] | 71 | .. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_ALL_ACCESS) |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 72 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 73 | Creates or opens the specified key, returning a |
| 74 | :ref:`handle object <handle-object>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 75 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 76 | *key* is an already open key, or one of the predefined |
| 77 | :ref:`HKEY_* constants <hkey-constants>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 78 | |
| 79 | *sub_key* is a string that names the key this method opens or creates. |
| 80 | |
| 81 | *res* is a reserved integer, and must be zero. The default is zero. |
| 82 | |
| 83 | *sam* is an integer that specifies an access mask that describes the desired |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 84 | security access for the key. Default is :const:`KEY_ALL_ACCESS`. See |
| 85 | :ref:`Access Rights <access-rights>` for other allowed values. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 86 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 87 | If *key* is one of the predefined keys, *sub_key* may be ``None``. In that |
| 88 | case, the handle returned is the same key handle passed in to the function. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 89 | |
| 90 | If the key already exists, this function opens the existing key. |
| 91 | |
| 92 | The return value is the handle of the opened key. If the function fails, a |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 93 | :exc:`OSError` exception is raised. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 94 | |
Georg Brandl | 4c25cf3 | 2010-04-22 07:00:42 +0000 | [diff] [blame] | 95 | .. versionadded:: 3.2 |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 96 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 97 | .. versionchanged:: 3.3 |
| 98 | This function used to raise a :exc:`WindowsError`, which is now an |
| 99 | alias of :exc:`OSError`. |
| 100 | |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 101 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 102 | .. function:: DeleteKey(key, sub_key) |
| 103 | |
| 104 | Deletes the specified key. |
| 105 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 106 | *key* is an already open key, or one of the predefined |
| 107 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 108 | |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 109 | *sub_key* is a string that must be a subkey of the key identified by the *key* |
| 110 | parameter. This value must not be ``None``, and the key may not have subkeys. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
| 112 | *This method can not delete keys with subkeys.* |
| 113 | |
| 114 | If the method succeeds, the entire key, including all of its values, is removed. |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 115 | If the method fails, a :exc:`OSError` exception is raised. |
| 116 | |
| 117 | .. versionchanged:: 3.3 |
| 118 | This function used to raise a :exc:`WindowsError`, which is now an |
| 119 | alias of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 120 | |
| 121 | |
Brian Curtin | 1771b54 | 2010-09-27 17:56:36 +0000 | [diff] [blame] | 122 | .. function:: DeleteKeyEx(key, sub_key, access=KEY_ALL_ACCESS, reserved=0) |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 123 | |
| 124 | Deletes the specified key. |
| 125 | |
| 126 | .. note:: |
| 127 | The :func:`DeleteKeyEx` function is implemented with the RegDeleteKeyEx |
| 128 | Windows API function, which is specific to 64-bit versions of Windows. |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 129 | See the `RegDeleteKeyEx documentation |
Benjamin Peterson | cc1f597 | 2010-06-06 02:41:24 +0000 | [diff] [blame] | 130 | <http://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx>`__. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 131 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 132 | *key* is an already open key, or one of the predefined |
| 133 | :ref:`HKEY_* constants <hkey-constants>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 134 | |
| 135 | *sub_key* is a string that must be a subkey of the key identified by the |
| 136 | *key* parameter. This value must not be ``None``, and the key may not have |
| 137 | subkeys. |
| 138 | |
| 139 | *res* is a reserved integer, and must be zero. The default is zero. |
| 140 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 141 | *sam* is an integer that specifies an access mask that describes the desired |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 142 | security access for the key. Default is :const:`KEY_ALL_ACCESS`. See |
| 143 | :ref:`Access Rights <access-rights>` for other allowed values. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 144 | |
| 145 | *This method can not delete keys with subkeys.* |
| 146 | |
| 147 | If the method succeeds, the entire key, including all of its values, is |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 148 | removed. If the method fails, a :exc:`OSError` exception is raised. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 149 | |
| 150 | On unsupported Windows versions, :exc:`NotImplementedError` is raised. |
| 151 | |
Georg Brandl | 4c25cf3 | 2010-04-22 07:00:42 +0000 | [diff] [blame] | 152 | .. versionadded:: 3.2 |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 153 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 154 | .. versionchanged:: 3.3 |
| 155 | This function used to raise a :exc:`WindowsError`, which is now an |
| 156 | alias of :exc:`OSError`. |
| 157 | |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 158 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 159 | .. function:: DeleteValue(key, value) |
| 160 | |
| 161 | Removes a named value from a registry key. |
| 162 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 163 | *key* is an already open key, or one of the predefined |
| 164 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 165 | |
| 166 | *value* is a string that identifies the value to remove. |
| 167 | |
| 168 | |
| 169 | .. function:: EnumKey(key, index) |
| 170 | |
| 171 | Enumerates subkeys of an open registry key, returning a string. |
| 172 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 173 | *key* is an already open key, or one of the predefined |
| 174 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 175 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 176 | *index* is an integer that identifies the index of the key to retrieve. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 177 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 178 | The function retrieves the name of one subkey each time it is called. It is |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 179 | typically called repeatedly until a :exc:`OSError` exception is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 180 | raised, indicating, no more values are available. |
| 181 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 182 | .. versionchanged:: 3.3 |
| 183 | This function used to raise a :exc:`WindowsError`, which is now an |
| 184 | alias of :exc:`OSError`. |
| 185 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 186 | |
| 187 | .. function:: EnumValue(key, index) |
| 188 | |
| 189 | Enumerates values of an open registry key, returning a tuple. |
| 190 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 191 | *key* is an already open key, or one of the predefined |
| 192 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 193 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 194 | *index* is an integer that identifies the index of the value to retrieve. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 195 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 196 | The function retrieves the name of one subkey each time it is called. It is |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 197 | typically called repeatedly, until a :exc:`OSError` exception is |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 198 | raised, indicating no more values. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 199 | |
| 200 | The result is a tuple of 3 items: |
| 201 | |
| 202 | +-------+--------------------------------------------+ |
| 203 | | Index | Meaning | |
| 204 | +=======+============================================+ |
| 205 | | ``0`` | A string that identifies the value name | |
| 206 | +-------+--------------------------------------------+ |
| 207 | | ``1`` | An object that holds the value data, and | |
| 208 | | | whose type depends on the underlying | |
| 209 | | | registry type | |
| 210 | +-------+--------------------------------------------+ |
| 211 | | ``2`` | An integer that identifies the type of the | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 212 | | | value data (see table in docs for | |
| 213 | | | :meth:`SetValueEx`) | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 214 | +-------+--------------------------------------------+ |
| 215 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 216 | .. versionchanged:: 3.3 |
| 217 | This function used to raise a :exc:`WindowsError`, which is now an |
| 218 | alias of :exc:`OSError`. |
| 219 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 220 | |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 221 | .. function:: ExpandEnvironmentStrings(str) |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 222 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 223 | Expands environment variable placeholders ``%NAME%`` in strings like |
| 224 | :const:`REG_EXPAND_SZ`:: |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 225 | |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 226 | >>> ExpandEnvironmentStrings('%windir%') |
| 227 | 'C:\\Windows' |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 228 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 229 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 230 | .. function:: FlushKey(key) |
| 231 | |
| 232 | Writes all the attributes of a key to the registry. |
| 233 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 234 | *key* is an already open key, or one of the predefined |
| 235 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 236 | |
Alexandre Vassalotti | 6461e10 | 2008-05-15 22:09:29 +0000 | [diff] [blame] | 237 | It is not necessary to call :func:`FlushKey` to change a key. Registry changes are |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 238 | flushed to disk by the registry using its lazy flusher. Registry changes are |
| 239 | also flushed to disk at system shutdown. Unlike :func:`CloseKey`, the |
| 240 | :func:`FlushKey` method returns only when all the data has been written to the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 241 | registry. An application should only call :func:`FlushKey` if it requires |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 242 | absolute certainty that registry changes are on disk. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 243 | |
| 244 | .. note:: |
| 245 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 246 | If you don't know whether a :func:`FlushKey` call is required, it probably |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 247 | isn't. |
| 248 | |
| 249 | |
Alexandre Vassalotti | 6461e10 | 2008-05-15 22:09:29 +0000 | [diff] [blame] | 250 | .. function:: LoadKey(key, sub_key, file_name) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 251 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 252 | Creates a subkey under the specified key and stores registration information |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 253 | from a specified file into that subkey. |
| 254 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 255 | *key* is a handle returned by :func:`ConnectRegistry` or one of the constants |
| 256 | :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 257 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 258 | *sub_key* is a string that identifies the subkey to load. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 259 | |
| 260 | *file_name* is the name of the file to load registry data from. This file must |
| 261 | have been created with the :func:`SaveKey` function. Under the file allocation |
| 262 | table (FAT) file system, the filename may not have an extension. |
| 263 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 264 | A call to :func:`LoadKey` fails if the calling process does not have the |
| 265 | :const:`SE_RESTORE_PRIVILEGE` privilege. Note that privileges are different |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 266 | from permissions -- see the `RegLoadKey documentation |
| 267 | <http://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx>`__ for |
| 268 | more details. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 269 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 270 | If *key* is a handle returned by :func:`ConnectRegistry`, then the path |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 271 | specified in *file_name* is relative to the remote computer. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 272 | |
| 273 | |
Brian Curtin | 13c7034 | 2012-05-29 18:34:45 -0500 | [diff] [blame] | 274 | .. function:: OpenKey(key, sub_key, reserved=0, access=KEY_READ) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 275 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 276 | Opens the specified key, returning a :ref:`handle object <handle-object>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 277 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 278 | *key* is an already open key, or one of the predefined |
| 279 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 280 | |
| 281 | *sub_key* is a string that identifies the sub_key to open. |
| 282 | |
Brian Curtin | 13c7034 | 2012-05-29 18:34:45 -0500 | [diff] [blame] | 283 | *reserved* is a reserved integer, and must be zero. The default is zero. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 284 | |
Brian Curtin | 13c7034 | 2012-05-29 18:34:45 -0500 | [diff] [blame] | 285 | *access* is an integer that specifies an access mask that describes the desired |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 286 | security access for the key. Default is :const:`KEY_READ`. See :ref:`Access |
| 287 | Rights <access-rights>` for other allowed values. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 288 | |
| 289 | The result is a new handle to the specified key. |
| 290 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 291 | If the function fails, :exc:`OSError` is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 292 | |
Georg Brandl | 61063cc | 2012-06-24 22:48:30 +0200 | [diff] [blame] | 293 | .. versionchanged:: 3.2 |
| 294 | Allow the use of named arguments. |
Brian Curtin | 1771b54 | 2010-09-27 17:56:36 +0000 | [diff] [blame] | 295 | |
Antoine Pitrou | 442ee03 | 2011-10-12 18:53:23 +0200 | [diff] [blame] | 296 | .. versionchanged:: 3.3 |
| 297 | This function used to raise a :exc:`WindowsError`, which is now an |
| 298 | alias of :exc:`OSError`. |
| 299 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 300 | |
| 301 | .. function:: OpenKeyEx() |
| 302 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 303 | The functionality of :func:`OpenKeyEx` is provided via :func:`OpenKey`, |
| 304 | by the use of default arguments. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 305 | |
| 306 | |
| 307 | .. function:: QueryInfoKey(key) |
| 308 | |
| 309 | Returns information about a key, as a tuple. |
| 310 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 311 | *key* is an already open key, or one of the predefined |
| 312 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 313 | |
| 314 | The result is a tuple of 3 items: |
| 315 | |
| 316 | +-------+---------------------------------------------+ |
| 317 | | Index | Meaning | |
| 318 | +=======+=============================================+ |
| 319 | | ``0`` | An integer giving the number of sub keys | |
| 320 | | | this key has. | |
| 321 | +-------+---------------------------------------------+ |
| 322 | | ``1`` | An integer giving the number of values this | |
| 323 | | | key has. | |
| 324 | +-------+---------------------------------------------+ |
Georg Brandl | ba956ae | 2007-11-29 17:24:34 +0000 | [diff] [blame] | 325 | | ``2`` | An integer giving when the key was last | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 326 | | | modified (if available) as 100's of | |
| 327 | | | nanoseconds since Jan 1, 1600. | |
| 328 | +-------+---------------------------------------------+ |
| 329 | |
| 330 | |
| 331 | .. function:: QueryValue(key, sub_key) |
| 332 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 333 | Retrieves the unnamed value for a key, as a string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 334 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 335 | *key* is an already open key, or one of the predefined |
| 336 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 337 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 338 | *sub_key* is a string that holds the name of the subkey with which the value is |
| 339 | associated. If this parameter is ``None`` or empty, the function retrieves the |
| 340 | value set by the :func:`SetValue` method for the key identified by *key*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 341 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 342 | Values in the registry have name, type, and data components. This method |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 343 | retrieves the data for a key's first value that has a NULL name. But the |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 344 | underlying API call doesn't return the type, so always use |
| 345 | :func:`QueryValueEx` if possible. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 346 | |
| 347 | |
| 348 | .. function:: QueryValueEx(key, value_name) |
| 349 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 350 | Retrieves the type and data for a specified value name associated with |
| 351 | an open registry key. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 352 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 353 | *key* is an already open key, or one of the predefined |
| 354 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 355 | |
| 356 | *value_name* is a string indicating the value to query. |
| 357 | |
| 358 | The result is a tuple of 2 items: |
| 359 | |
| 360 | +-------+-----------------------------------------+ |
| 361 | | Index | Meaning | |
| 362 | +=======+=========================================+ |
| 363 | | ``0`` | The value of the registry item. | |
| 364 | +-------+-----------------------------------------+ |
| 365 | | ``1`` | An integer giving the registry type for | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 366 | | | this value (see table in docs for | |
| 367 | | | :meth:`SetValueEx`) | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 368 | +-------+-----------------------------------------+ |
| 369 | |
| 370 | |
| 371 | .. function:: SaveKey(key, file_name) |
| 372 | |
| 373 | Saves the specified key, and all its subkeys to the specified file. |
| 374 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 375 | *key* is an already open key, or one of the predefined |
| 376 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 377 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 378 | *file_name* is the name of the file to save registry data to. This file |
| 379 | cannot already exist. If this filename includes an extension, it cannot be |
| 380 | used on file allocation table (FAT) file systems by the :meth:`LoadKey` |
| 381 | method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 382 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 383 | If *key* represents a key on a remote computer, the path described by |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 384 | *file_name* is relative to the remote computer. The caller of this method must |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 385 | possess the :const:`SeBackupPrivilege` security privilege. Note that |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 386 | privileges are different than permissions -- see the |
| 387 | `Conflicts Between User Rights and Permissions documentation |
| 388 | <http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__ |
| 389 | for more details. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 390 | |
| 391 | This function passes NULL for *security_attributes* to the API. |
| 392 | |
| 393 | |
| 394 | .. function:: SetValue(key, sub_key, type, value) |
| 395 | |
| 396 | Associates a value with a specified key. |
| 397 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 398 | *key* is an already open key, or one of the predefined |
| 399 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 400 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 401 | *sub_key* is a string that names the subkey with which the value is associated. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 402 | |
| 403 | *type* is an integer that specifies the type of the data. Currently this must be |
| 404 | :const:`REG_SZ`, meaning only strings are supported. Use the :func:`SetValueEx` |
| 405 | function for support for other data types. |
| 406 | |
| 407 | *value* is a string that specifies the new value. |
| 408 | |
| 409 | If the key specified by the *sub_key* parameter does not exist, the SetValue |
| 410 | function creates it. |
| 411 | |
| 412 | Value lengths are limited by available memory. Long values (more than 2048 |
| 413 | bytes) should be stored as files with the filenames stored in the configuration |
| 414 | registry. This helps the registry perform efficiently. |
| 415 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 416 | The key identified by the *key* parameter must have been opened with |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 417 | :const:`KEY_SET_VALUE` access. |
| 418 | |
| 419 | |
| 420 | .. function:: SetValueEx(key, value_name, reserved, type, value) |
| 421 | |
| 422 | Stores data in the value field of an open registry key. |
| 423 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 424 | *key* is an already open key, or one of the predefined |
| 425 | :ref:`HKEY_* constants <hkey-constants>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 426 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 427 | *value_name* is a string that names the subkey with which the value is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 428 | associated. |
| 429 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 430 | *type* is an integer that specifies the type of the data. See |
| 431 | :ref:`Value Types <value-types>` for the available types. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 432 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 433 | *reserved* can be anything -- zero is always passed to the API. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 434 | |
| 435 | *value* is a string that specifies the new value. |
| 436 | |
| 437 | This method can also set additional value and type information for the specified |
| 438 | key. The key identified by the key parameter must have been opened with |
| 439 | :const:`KEY_SET_VALUE` access. |
| 440 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 441 | To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 442 | |
| 443 | Value lengths are limited by available memory. Long values (more than 2048 |
| 444 | bytes) should be stored as files with the filenames stored in the configuration |
| 445 | registry. This helps the registry perform efficiently. |
| 446 | |
| 447 | |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 448 | .. function:: DisableReflectionKey(key) |
| 449 | |
| 450 | Disables registry reflection for 32-bit processes running on a 64-bit |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 451 | operating system. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 452 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 453 | *key* is an already open key, or one of the predefined :ref:`HKEY_* constants |
| 454 | <hkey-constants>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 455 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 456 | Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating |
| 457 | system. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 458 | |
| 459 | If the key is not on the reflection list, the function succeeds but has no |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 460 | effect. Disabling reflection for a key does not affect reflection of any |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 461 | subkeys. |
| 462 | |
| 463 | |
| 464 | .. function:: EnableReflectionKey(key) |
| 465 | |
| 466 | Restores registry reflection for the specified disabled key. |
| 467 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 468 | *key* is an already open key, or one of the predefined :ref:`HKEY_* constants |
| 469 | <hkey-constants>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 470 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 471 | Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating |
| 472 | system. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 473 | |
| 474 | Restoring reflection for a key does not affect reflection of any subkeys. |
| 475 | |
| 476 | |
| 477 | .. function:: QueryReflectionKey(key) |
| 478 | |
| 479 | Determines the reflection state for the specified key. |
| 480 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 481 | *key* is an already open key, or one of the predefined |
| 482 | :ref:`HKEY_* constants <hkey-constants>`. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 483 | |
| 484 | Returns ``True`` if reflection is disabled. |
| 485 | |
| 486 | Will generally raise :exc:`NotImplemented` if executed on a 32-bit |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 487 | operating system. |
Brian Curtin | 3035c39 | 2010-04-21 23:56:21 +0000 | [diff] [blame] | 488 | |
| 489 | |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 490 | .. _constants: |
| 491 | |
| 492 | Constants |
| 493 | ------------------ |
| 494 | |
| 495 | The following constants are defined for use in many :mod:`_winreg` functions. |
| 496 | |
| 497 | .. _hkey-constants: |
| 498 | |
| 499 | HKEY_* Constants |
| 500 | ++++++++++++++++ |
| 501 | |
| 502 | .. data:: HKEY_CLASSES_ROOT |
| 503 | |
| 504 | Registry entries subordinate to this key define types (or classes) of |
| 505 | documents and the properties associated with those types. Shell and |
| 506 | COM applications use the information stored under this key. |
| 507 | |
| 508 | |
| 509 | .. data:: HKEY_CURRENT_USER |
| 510 | |
| 511 | Registry entries subordinate to this key define the preferences of |
| 512 | the current user. These preferences include the settings of |
| 513 | environment variables, data about program groups, colors, printers, |
| 514 | network connections, and application preferences. |
| 515 | |
| 516 | .. data:: HKEY_LOCAL_MACHINE |
| 517 | |
| 518 | Registry entries subordinate to this key define the physical state |
| 519 | of the computer, including data about the bus type, system memory, |
| 520 | and installed hardware and software. |
| 521 | |
| 522 | .. data:: HKEY_USERS |
| 523 | |
| 524 | Registry entries subordinate to this key define the default user |
| 525 | configuration for new users on the local computer and the user |
| 526 | configuration for the current user. |
| 527 | |
| 528 | .. data:: HKEY_PERFORMANCE_DATA |
| 529 | |
| 530 | Registry entries subordinate to this key allow you to access |
| 531 | performance data. The data is not actually stored in the registry; |
| 532 | the registry functions cause the system to collect the data from |
| 533 | its source. |
| 534 | |
| 535 | |
| 536 | .. data:: HKEY_CURRENT_CONFIG |
| 537 | |
| 538 | Contains information about the current hardware profile of the |
| 539 | local computer system. |
| 540 | |
| 541 | .. data:: HKEY_DYN_DATA |
| 542 | |
| 543 | This key is not used in versions of Windows after 98. |
| 544 | |
| 545 | |
| 546 | .. _access-rights: |
| 547 | |
| 548 | Access Rights |
| 549 | +++++++++++++ |
| 550 | |
| 551 | For more information, see `Registry Key Security and Access |
| 552 | <http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__. |
| 553 | |
| 554 | .. data:: KEY_ALL_ACCESS |
| 555 | |
| 556 | Combines the STANDARD_RIGHTS_REQUIRED, :const:`KEY_QUERY_VALUE`, |
| 557 | :const:`KEY_SET_VALUE`, :const:`KEY_CREATE_SUB_KEY`, |
| 558 | :const:`KEY_ENUMERATE_SUB_KEYS`, :const:`KEY_NOTIFY`, |
| 559 | and :const:`KEY_CREATE_LINK` access rights. |
| 560 | |
| 561 | .. data:: KEY_WRITE |
| 562 | |
| 563 | Combines the STANDARD_RIGHTS_WRITE, :const:`KEY_SET_VALUE`, and |
| 564 | :const:`KEY_CREATE_SUB_KEY` access rights. |
| 565 | |
| 566 | .. data:: KEY_READ |
| 567 | |
| 568 | Combines the STANDARD_RIGHTS_READ, :const:`KEY_QUERY_VALUE`, |
| 569 | :const:`KEY_ENUMERATE_SUB_KEYS`, and :const:`KEY_NOTIFY` values. |
| 570 | |
| 571 | .. data:: KEY_EXECUTE |
| 572 | |
| 573 | Equivalent to :const:`KEY_READ`. |
| 574 | |
| 575 | .. data:: KEY_QUERY_VALUE |
| 576 | |
| 577 | Required to query the values of a registry key. |
| 578 | |
| 579 | .. data:: KEY_SET_VALUE |
| 580 | |
| 581 | Required to create, delete, or set a registry value. |
| 582 | |
| 583 | .. data:: KEY_CREATE_SUB_KEY |
| 584 | |
| 585 | Required to create a subkey of a registry key. |
| 586 | |
| 587 | .. data:: KEY_ENUMERATE_SUB_KEYS |
| 588 | |
| 589 | Required to enumerate the subkeys of a registry key. |
| 590 | |
| 591 | .. data:: KEY_NOTIFY |
| 592 | |
| 593 | Required to request change notifications for a registry key or for |
| 594 | subkeys of a registry key. |
| 595 | |
| 596 | .. data:: KEY_CREATE_LINK |
| 597 | |
| 598 | Reserved for system use. |
| 599 | |
| 600 | |
| 601 | .. _64-bit-access-rights: |
| 602 | |
| 603 | 64-bit Specific |
| 604 | *************** |
| 605 | |
Georg Brandl | 6faee4e | 2010-09-21 14:48:28 +0000 | [diff] [blame] | 606 | For more information, see `Accessing an Alternate Registry View |
Brian Curtin | 2d067c8 | 2010-05-11 20:35:47 +0000 | [diff] [blame] | 607 | <http://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx>`__. |
| 608 | |
| 609 | .. data:: KEY_WOW64_64KEY |
| 610 | |
| 611 | Indicates that an application on 64-bit Windows should operate on |
| 612 | the 64-bit registry view. |
| 613 | |
| 614 | .. data:: KEY_WOW64_32KEY |
| 615 | |
| 616 | Indicates that an application on 64-bit Windows should operate on |
| 617 | the 32-bit registry view. |
| 618 | |
| 619 | |
| 620 | .. _value-types: |
| 621 | |
| 622 | Value Types |
| 623 | +++++++++++ |
| 624 | |
| 625 | For more information, see `Registry Value Types |
| 626 | <http://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx>`__. |
| 627 | |
| 628 | .. data:: REG_BINARY |
| 629 | |
| 630 | Binary data in any form. |
| 631 | |
| 632 | .. data:: REG_DWORD |
| 633 | |
| 634 | 32-bit number. |
| 635 | |
| 636 | .. data:: REG_DWORD_LITTLE_ENDIAN |
| 637 | |
| 638 | A 32-bit number in little-endian format. |
| 639 | |
| 640 | .. data:: REG_DWORD_BIG_ENDIAN |
| 641 | |
| 642 | A 32-bit number in big-endian format. |
| 643 | |
| 644 | .. data:: REG_EXPAND_SZ |
| 645 | |
| 646 | Null-terminated string containing references to environment |
| 647 | variables (``%PATH%``). |
| 648 | |
| 649 | .. data:: REG_LINK |
| 650 | |
| 651 | A Unicode symbolic link. |
| 652 | |
| 653 | .. data:: REG_MULTI_SZ |
| 654 | |
| 655 | A sequence of null-terminated strings, terminated by two null characters. |
| 656 | (Python handles this termination automatically.) |
| 657 | |
| 658 | .. data:: REG_NONE |
| 659 | |
| 660 | No defined value type. |
| 661 | |
| 662 | .. data:: REG_RESOURCE_LIST |
| 663 | |
| 664 | A device-driver resource list. |
| 665 | |
| 666 | .. data:: REG_FULL_RESOURCE_DESCRIPTOR |
| 667 | |
| 668 | A hardware setting. |
| 669 | |
| 670 | .. data:: REG_RESOURCE_REQUIREMENTS_LIST |
| 671 | |
| 672 | A hardware resource list. |
| 673 | |
| 674 | .. data:: REG_SZ |
| 675 | |
| 676 | A null-terminated string. |
| 677 | |
| 678 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 679 | .. _handle-object: |
| 680 | |
| 681 | Registry Handle Objects |
| 682 | ----------------------- |
| 683 | |
| 684 | This object wraps a Windows HKEY object, automatically closing it when the |
| 685 | object is destroyed. To guarantee cleanup, you can call either the |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 686 | :meth:`~PyHKEY.Close` method on the object, or the :func:`CloseKey` function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 687 | |
| 688 | All registry functions in this module return one of these objects. |
| 689 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 690 | All registry functions in this module which accept a handle object also accept |
| 691 | an integer, however, use of the handle object is encouraged. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 692 | |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 693 | Handle objects provide semantics for :meth:`__bool__` -- thus :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 694 | |
| 695 | if handle: |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 696 | print("Yes") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 697 | |
| 698 | will print ``Yes`` if the handle is currently valid (has not been closed or |
| 699 | detached). |
| 700 | |
| 701 | The object also support comparison semantics, so handle objects will compare |
| 702 | true if they both reference the same underlying Windows handle value. |
| 703 | |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 704 | Handle objects can be converted to an integer (e.g., using the built-in |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 705 | :func:`int` function), in which case the underlying Windows handle value is |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 706 | returned. You can also use the :meth:`~PyHKEY.Detach` method to return the |
| 707 | integer handle, and also disconnect the Windows handle from the handle object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 708 | |
| 709 | |
| 710 | .. method:: PyHKEY.Close() |
| 711 | |
| 712 | Closes the underlying Windows handle. |
| 713 | |
| 714 | If the handle is already closed, no error is raised. |
| 715 | |
| 716 | |
| 717 | .. method:: PyHKEY.Detach() |
| 718 | |
| 719 | Detaches the Windows handle from the handle object. |
| 720 | |
Georg Brandl | 5c10664 | 2007-11-29 17:41:05 +0000 | [diff] [blame] | 721 | The result is an integer that holds the value of the handle before it is |
| 722 | detached. If the handle is already detached or closed, this will return |
| 723 | zero. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 724 | |
| 725 | After calling this function, the handle is effectively invalidated, but the |
Ezio Melotti | bc37298 | 2010-04-25 17:48:01 +0000 | [diff] [blame] | 726 | handle is not closed. You would call this function when you need the |
| 727 | underlying Win32 handle to exist beyond the lifetime of the handle object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 728 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 729 | .. method:: PyHKEY.__enter__() |
| 730 | PyHKEY.__exit__(\*exc_info) |
| 731 | |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 732 | The HKEY object implements :meth:`~object.__enter__` and |
| 733 | :meth:`~object.__exit__` and thus supports the context protocol for the |
| 734 | :keyword:`with` statement:: |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 735 | |
| 736 | with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: |
Georg Brandl | 8173fb3 | 2010-05-19 21:03:51 +0000 | [diff] [blame] | 737 | ... # work with key |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 738 | |
| 739 | will automatically close *key* when control leaves the :keyword:`with` block. |
| 740 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 741 | |