winreg.rst 23.5 KB
Newer Older
1
:mod:`winreg` --- Windows registry access
2 3
=========================================

4
.. module:: winreg
5 6
   :platform: Windows
   :synopsis: Routines and objects for manipulating the Windows registry.
7

8 9
.. sectionauthor:: Mark Hammond <MarkH@ActiveState.com>

10
--------------
11 12

These functions expose the Windows registry API to Python.  Instead of using an
13 14 15
integer as the registry handle, a :ref:`handle object <handle-object>` is used
to ensure that the handles are closed correctly, even if the programmer neglects
to explicitly close them.
16

17 18 19 20 21 22 23 24 25 26 27
.. _exception-changed:

.. versionchanged:: 3.3
   Several functions in this module used to raise a
   :exc:`WindowsError`, which is now an alias of :exc:`OSError`.

.. _functions:

Functions
------------------

28 29 30 31 32
This module offers the following functions:


.. function:: CloseKey(hkey)

33
   Closes a previously opened registry key.  The *hkey* argument specifies a
34 35
   previously opened key.

36
   .. note::
37 38 39 40

      If *hkey* is not closed using this method (or via :meth:`hkey.Close()
      <PyHKEY.Close>`), it is closed when the *hkey* object is destroyed by
      Python.
41 42 43 44


.. function:: ConnectRegistry(computer_name, key)

45 46
   Establishes a connection to a predefined registry handle on another computer,
   and returns a :ref:`handle object <handle-object>`.
47

48
   *computer_name* is the name of the remote computer, of the form
49 50 51 52
   ``r"\\computername"``.  If ``None``, the local computer is used.

   *key* is the predefined handle to connect to.

53
   The return value is the handle of the opened key. If the function fails, an
54 55 56
   :exc:`OSError` exception is raised.

   .. versionchanged:: 3.3
57
      See :ref:`above <exception-changed>`.
58 59 60 61


.. function:: CreateKey(key, sub_key)

62 63
   Creates or opens the specified key, returning a
   :ref:`handle object <handle-object>`.
64

65 66
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
67

68
   *sub_key* is a string that names the key this method opens or creates.
69

70 71
   If *key* is one of the predefined keys, *sub_key* may be ``None``. In that
   case, the handle returned is the same key handle passed in to the function.
72 73 74

   If the key already exists, this function opens the existing key.

75
   The return value is the handle of the opened key. If the function fails, an
76 77 78
   :exc:`OSError` exception is raised.

   .. versionchanged:: 3.3
79
      See :ref:`above <exception-changed>`.
80 81


82
.. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE)
Brian Curtin's avatar
Brian Curtin committed
83

84 85
   Creates or opens the specified key, returning a
   :ref:`handle object <handle-object>`.
Brian Curtin's avatar
Brian Curtin committed
86

87 88
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
Brian Curtin's avatar
Brian Curtin committed
89 90 91

   *sub_key* is a string that names the key this method opens or creates.

92
   *reserved* is a reserved integer, and must be zero. The default is zero.
Brian Curtin's avatar
Brian Curtin committed
93

94 95
   *access* is an integer that specifies an access mask that describes the desired
   security access for the key.  Default is :const:`KEY_WRITE`.  See
96
   :ref:`Access Rights <access-rights>` for other allowed values.
Brian Curtin's avatar
Brian Curtin committed
97

98 99
   If *key* is one of the predefined keys, *sub_key* may be ``None``. In that
   case, the handle returned is the same key handle passed in to the function.
Brian Curtin's avatar
Brian Curtin committed
100 101 102

   If the key already exists, this function opens the existing key.

103
   The return value is the handle of the opened key. If the function fails, an
104
   :exc:`OSError` exception is raised.
Brian Curtin's avatar
Brian Curtin committed
105

Georg Brandl's avatar
Georg Brandl committed
106
   .. versionadded:: 3.2
Brian Curtin's avatar
Brian Curtin committed
107

108
   .. versionchanged:: 3.3
109
      See :ref:`above <exception-changed>`.
110

Brian Curtin's avatar
Brian Curtin committed
111

112 113 114 115
.. function:: DeleteKey(key, sub_key)

   Deletes the specified key.

116 117
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
118

Brian Curtin's avatar
Brian Curtin committed
119 120
   *sub_key* is a string that must be a subkey of the key identified by the *key*
   parameter.  This value must not be ``None``, and the key may not have subkeys.
121 122 123 124

   *This method can not delete keys with subkeys.*

   If the method succeeds, the entire key, including all of its values, is removed.
125
   If the method fails, an :exc:`OSError` exception is raised.
126 127

   .. versionchanged:: 3.3
128
      See :ref:`above <exception-changed>`.
129 130


131
.. function:: DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)
Brian Curtin's avatar
Brian Curtin committed
132 133 134 135 136 137

   Deletes the specified key.

   .. note::
      The :func:`DeleteKeyEx` function is implemented with the RegDeleteKeyEx
      Windows API function, which is specific to 64-bit versions of Windows.
138
      See the `RegDeleteKeyEx documentation
139
      <https://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx>`__.
Brian Curtin's avatar
Brian Curtin committed
140

141 142
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
Brian Curtin's avatar
Brian Curtin committed
143 144 145 146 147

   *sub_key* is a string that must be a subkey of the key identified by the
   *key* parameter. This value must not be ``None``, and the key may not have
   subkeys.

148
   *reserved* is a reserved integer, and must be zero. The default is zero.
Brian Curtin's avatar
Brian Curtin committed
149

150
   *access* is an integer that specifies an access mask that describes the desired
151
   security access for the key.  Default is :const:`KEY_WOW64_64KEY`.  See
152
   :ref:`Access Rights <access-rights>` for other allowed values.
Brian Curtin's avatar
Brian Curtin committed
153 154 155 156

   *This method can not delete keys with subkeys.*

   If the method succeeds, the entire key, including all of its values, is
157
   removed. If the method fails, an :exc:`OSError` exception is raised.
Brian Curtin's avatar
Brian Curtin committed
158 159 160

   On unsupported Windows versions, :exc:`NotImplementedError` is raised.

Georg Brandl's avatar
Georg Brandl committed
161
   .. versionadded:: 3.2
Brian Curtin's avatar
Brian Curtin committed
162

163
   .. versionchanged:: 3.3
164
      See :ref:`above <exception-changed>`.
165

Brian Curtin's avatar
Brian Curtin committed
166

167 168 169 170
.. function:: DeleteValue(key, value)

   Removes a named value from a registry key.

171 172
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
173 174 175 176 177 178 179 180

   *value* is a string that identifies the value to remove.


.. function:: EnumKey(key, index)

   Enumerates subkeys of an open registry key, returning a string.

181 182
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
183

184
   *index* is an integer that identifies the index of the key to retrieve.
185

186
   The function retrieves the name of one subkey each time it is called.  It is
187
   typically called repeatedly until an :exc:`OSError` exception is
188 189
   raised, indicating, no more values are available.

190
   .. versionchanged:: 3.3
191
      See :ref:`above <exception-changed>`.
192

193 194 195 196 197

.. function:: EnumValue(key, index)

   Enumerates values of an open registry key, returning a tuple.

198 199
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
200

201
   *index* is an integer that identifies the index of the value to retrieve.
202

203
   The function retrieves the name of one subkey each time it is called. It is
204
   typically called repeatedly, until an :exc:`OSError` exception is
205
   raised, indicating no more values.
206 207 208 209 210 211 212 213 214 215 216 217 218

   The result is a tuple of 3 items:

   +-------+--------------------------------------------+
   | Index | Meaning                                    |
   +=======+============================================+
   | ``0`` | A string that identifies the value name    |
   +-------+--------------------------------------------+
   | ``1`` | An object that holds the value data, and   |
   |       | whose type depends on the underlying       |
   |       | registry type                              |
   +-------+--------------------------------------------+
   | ``2`` | An integer that identifies the type of the |
219 220
   |       | value data (see table in docs for          |
   |       | :meth:`SetValueEx`)                        |
221 222
   +-------+--------------------------------------------+

223
   .. versionchanged:: 3.3
224
      See :ref:`above <exception-changed>`.
225

226

227
.. function:: ExpandEnvironmentStrings(str)
228

229 230
   Expands environment variable placeholders ``%NAME%`` in strings like
   :const:`REG_EXPAND_SZ`::
231

232 233
      >>> ExpandEnvironmentStrings('%windir%')
      'C:\\Windows'
234 235


236 237 238 239
.. function:: FlushKey(key)

   Writes all the attributes of a key to the registry.

240 241
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
242

243
   It is not necessary to call :func:`FlushKey` to change a key. Registry changes are
244 245 246
   flushed to disk by the registry using its lazy flusher.  Registry changes are
   also flushed to disk at system shutdown.  Unlike :func:`CloseKey`, the
   :func:`FlushKey` method returns only when all the data has been written to the
247
   registry. An application should only call :func:`FlushKey` if it requires
248
   absolute certainty that registry changes are on disk.
249 250 251

   .. note::

252
      If you don't know whether a :func:`FlushKey` call is required, it probably
253 254 255
      isn't.


256
.. function:: LoadKey(key, sub_key, file_name)
257

258
   Creates a subkey under the specified key and stores registration information
259 260
   from a specified file into that subkey.

261 262
   *key* is a handle returned by :func:`ConnectRegistry` or one of the constants
   :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`.
263

264
   *sub_key* is a string that identifies the subkey to load.
265 266 267 268 269

   *file_name* is the name of the file to load registry data from. This file must
   have been created with the :func:`SaveKey` function. Under the file allocation
   table (FAT) file system, the filename may not have an extension.

270 271
   A call to :func:`LoadKey` fails if the calling process does not have the
   :const:`SE_RESTORE_PRIVILEGE` privilege.  Note that privileges are different
272
   from permissions -- see the `RegLoadKey documentation
273
   <https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx>`__ for
274
   more details.
275

276
   If *key* is a handle returned by :func:`ConnectRegistry`, then the path
277
   specified in *file_name* is relative to the remote computer.
278 279


280
.. function:: OpenKey(key, sub_key, reserved=0, access=KEY_READ)
281
              OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ)
282

283
   Opens the specified key, returning a :ref:`handle object <handle-object>`.
284

285 286
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
287 288 289

   *sub_key* is a string that identifies the sub_key to open.

290
   *reserved* is a reserved integer, and must be zero.  The default is zero.
291

292
   *access* is an integer that specifies an access mask that describes the desired
293 294
   security access for the key.  Default is :const:`KEY_READ`.  See :ref:`Access
   Rights <access-rights>` for other allowed values.
295 296 297

   The result is a new handle to the specified key.

298
   If the function fails, :exc:`OSError` is raised.
299

300 301
   .. versionchanged:: 3.2
      Allow the use of named arguments.
302

303
   .. versionchanged:: 3.3
304
      See :ref:`above <exception-changed>`.
305

306 307 308 309 310

.. function:: QueryInfoKey(key)

   Returns information about a key, as a tuple.

311 312
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
313 314 315 316 317 318 319 320 321 322 323 324

   The result is a tuple of 3 items:

   +-------+---------------------------------------------+
   | Index | Meaning                                     |
   +=======+=============================================+
   | ``0`` | An integer giving the number of sub keys    |
   |       | this key has.                               |
   +-------+---------------------------------------------+
   | ``1`` | An integer giving the number of values this |
   |       | key has.                                    |
   +-------+---------------------------------------------+
325
   | ``2`` | An integer giving when the key was last     |
326
   |       | modified (if available) as 100's of         |
327
   |       | nanoseconds since Jan 1, 1601.              |
328 329 330 331 332
   +-------+---------------------------------------------+


.. function:: QueryValue(key, sub_key)

333
   Retrieves the unnamed value for a key, as a string.
334

335 336
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
337

338 339 340
   *sub_key* is a string that holds the name of the subkey with which the value is
   associated.  If this parameter is ``None`` or empty, the function retrieves the
   value set by the :func:`SetValue` method for the key identified by *key*.
341

Benjamin Peterson's avatar
Benjamin Peterson committed
342
   Values in the registry have name, type, and data components. This method
343
   retrieves the data for a key's first value that has a NULL name. But the
Benjamin Peterson's avatar
Benjamin Peterson committed
344 345
   underlying API call doesn't return the type, so always use
   :func:`QueryValueEx` if possible.
346 347 348 349


.. function:: QueryValueEx(key, value_name)

350 351
   Retrieves the type and data for a specified value name associated with
   an open registry key.
352

353 354
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
355 356 357 358 359 360 361 362 363 364 365

   *value_name* is a string indicating the value to query.

   The result is a tuple of 2 items:

   +-------+-----------------------------------------+
   | Index | Meaning                                 |
   +=======+=========================================+
   | ``0`` | The value of the registry item.         |
   +-------+-----------------------------------------+
   | ``1`` | An integer giving the registry type for |
366 367
   |       | this value (see table in docs for       |
   |       | :meth:`SetValueEx`)                     |
368 369 370 371 372 373 374
   +-------+-----------------------------------------+


.. function:: SaveKey(key, file_name)

   Saves the specified key, and all its subkeys to the specified file.

375 376
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
377

378 379 380 381
   *file_name* is the name of the file to save registry data to.  This file
   cannot already exist. If this filename includes an extension, it cannot be
   used on file allocation table (FAT) file systems by the :meth:`LoadKey`
   method.
382

383
   If *key* represents a key on a remote computer, the path described by
384
   *file_name* is relative to the remote computer. The caller of this method must
385
   possess the :const:`SeBackupPrivilege` security privilege.  Note that
386 387
   privileges are different than permissions -- see the
   `Conflicts Between User Rights and Permissions documentation
388
   <https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__
389
   for more details.
390 391 392 393 394 395 396 397

   This function passes NULL for *security_attributes* to the API.


.. function:: SetValue(key, sub_key, type, value)

   Associates a value with a specified key.

398 399
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
400

401
   *sub_key* is a string that names the subkey with which the value is associated.
402 403 404 405 406 407 408 409 410 411 412 413 414 415

   *type* is an integer that specifies the type of the data. Currently this must be
   :const:`REG_SZ`, meaning only strings are supported.  Use the :func:`SetValueEx`
   function for support for other data types.

   *value* is a string that specifies the new value.

   If the key specified by the *sub_key* parameter does not exist, the SetValue
   function creates it.

   Value lengths are limited by available memory. Long values (more than 2048
   bytes) should be stored as files with the filenames stored in the configuration
   registry.  This helps the registry perform efficiently.

416
   The key identified by the *key* parameter must have been opened with
417 418 419 420 421 422 423
   :const:`KEY_SET_VALUE` access.


.. function:: SetValueEx(key, value_name, reserved, type, value)

   Stores data in the value field of an open registry key.

424 425
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
426

427
   *value_name* is a string that names the subkey with which the value is
428 429
   associated.

430 431
   *reserved* can be anything -- zero is always passed to the API.

432 433
   *type* is an integer that specifies the type of the data. See
   :ref:`Value Types <value-types>` for the available types.
434 435 436 437 438 439 440

   *value* is a string that specifies the new value.

   This method can also set additional value and type information for the specified
   key.  The key identified by the key parameter must have been opened with
   :const:`KEY_SET_VALUE` access.

441
   To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods.
442 443 444 445 446 447

   Value lengths are limited by available memory. Long values (more than 2048
   bytes) should be stored as files with the filenames stored in the configuration
   registry.  This helps the registry perform efficiently.


Brian Curtin's avatar
Brian Curtin committed
448 449 450
.. function:: DisableReflectionKey(key)

   Disables registry reflection for 32-bit processes running on a 64-bit
451
   operating system.
Brian Curtin's avatar
Brian Curtin committed
452

453 454
   *key* is an already open key, or one of the predefined :ref:`HKEY_* constants
   <hkey-constants>`.
Brian Curtin's avatar
Brian Curtin committed
455

456 457
   Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating
   system.
Brian Curtin's avatar
Brian Curtin committed
458 459

   If the key is not on the reflection list, the function succeeds but has no
460
   effect.  Disabling reflection for a key does not affect reflection of any
Brian Curtin's avatar
Brian Curtin committed
461 462 463 464 465 466 467
   subkeys.


.. function:: EnableReflectionKey(key)

   Restores registry reflection for the specified disabled key.

468 469
   *key* is an already open key, or one of the predefined :ref:`HKEY_* constants
   <hkey-constants>`.
Brian Curtin's avatar
Brian Curtin committed
470

471 472
   Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating
   system.
Brian Curtin's avatar
Brian Curtin committed
473 474 475 476 477 478 479 480

   Restoring reflection for a key does not affect reflection of any subkeys.


.. function:: QueryReflectionKey(key)

   Determines the reflection state for the specified key.

481 482
   *key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.
Brian Curtin's avatar
Brian Curtin committed
483 484 485 486

   Returns ``True`` if reflection is disabled.

   Will generally raise :exc:`NotImplemented` if executed on a 32-bit
487
   operating system.
Brian Curtin's avatar
Brian Curtin committed
488 489


490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
.. _constants:

Constants
------------------

The following constants are defined for use in many :mod:`_winreg` functions.

.. _hkey-constants:

HKEY_* Constants
++++++++++++++++

.. data:: HKEY_CLASSES_ROOT

   Registry entries subordinate to this key define types (or classes) of
   documents and the properties associated with those types. Shell and
   COM applications use the information stored under this key.


.. data:: HKEY_CURRENT_USER

   Registry entries subordinate to this key define the preferences of
   the current user. These preferences include the settings of
   environment variables, data about program groups, colors, printers,
   network connections, and application preferences.

.. data:: HKEY_LOCAL_MACHINE

   Registry entries subordinate to this key define the physical state
   of the computer, including data about the bus type, system memory,
   and installed hardware and software.

.. data:: HKEY_USERS

   Registry entries subordinate to this key define the default user
   configuration for new users on the local computer and the user
   configuration for the current user.

.. data:: HKEY_PERFORMANCE_DATA

   Registry entries subordinate to this key allow you to access
   performance data. The data is not actually stored in the registry;
   the registry functions cause the system to collect the data from
   its source.


.. data:: HKEY_CURRENT_CONFIG

   Contains information about the current hardware profile of the
   local computer system.

.. data:: HKEY_DYN_DATA

   This key is not used in versions of Windows after 98.


.. _access-rights:

Access Rights
+++++++++++++

For more information, see `Registry Key Security and Access
552
<https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__.
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

.. data:: KEY_ALL_ACCESS

   Combines the STANDARD_RIGHTS_REQUIRED, :const:`KEY_QUERY_VALUE`,
   :const:`KEY_SET_VALUE`, :const:`KEY_CREATE_SUB_KEY`,
   :const:`KEY_ENUMERATE_SUB_KEYS`, :const:`KEY_NOTIFY`,
   and :const:`KEY_CREATE_LINK` access rights.

.. data:: KEY_WRITE

   Combines the STANDARD_RIGHTS_WRITE, :const:`KEY_SET_VALUE`, and
   :const:`KEY_CREATE_SUB_KEY` access rights.

.. data:: KEY_READ

   Combines the STANDARD_RIGHTS_READ, :const:`KEY_QUERY_VALUE`,
   :const:`KEY_ENUMERATE_SUB_KEYS`, and :const:`KEY_NOTIFY` values.

.. data:: KEY_EXECUTE

   Equivalent to :const:`KEY_READ`.

.. data:: KEY_QUERY_VALUE

   Required to query the values of a registry key.

.. data:: KEY_SET_VALUE

   Required to create, delete, or set a registry value.

.. data:: KEY_CREATE_SUB_KEY

   Required to create a subkey of a registry key.

.. data:: KEY_ENUMERATE_SUB_KEYS

   Required to enumerate the subkeys of a registry key.

.. data:: KEY_NOTIFY

   Required to request change notifications for a registry key or for
   subkeys of a registry key.

.. data:: KEY_CREATE_LINK

   Reserved for system use.


.. _64-bit-access-rights:

64-bit Specific
***************

Georg Brandl's avatar
Georg Brandl committed
606
For more information, see `Accessing an Alternate Registry View
607
<https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx>`__.
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

.. data:: KEY_WOW64_64KEY

   Indicates that an application on 64-bit Windows should operate on
   the 64-bit registry view.

.. data:: KEY_WOW64_32KEY

   Indicates that an application on 64-bit Windows should operate on
   the 32-bit registry view.


.. _value-types:

Value Types
+++++++++++

For more information, see `Registry Value Types
626
<https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx>`__.
627 628 629 630 631 632 633 634 635 636 637

.. data:: REG_BINARY

   Binary data in any form.

.. data:: REG_DWORD

   32-bit number.

.. data:: REG_DWORD_LITTLE_ENDIAN

638
   A 32-bit number in little-endian format. Equivalent to :const:`REG_DWORD`.
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661

.. data:: REG_DWORD_BIG_ENDIAN

   A 32-bit number in big-endian format.

.. data:: REG_EXPAND_SZ

   Null-terminated string containing references to environment
   variables (``%PATH%``).

.. data:: REG_LINK

   A Unicode symbolic link.

.. data:: REG_MULTI_SZ

   A sequence of null-terminated strings, terminated by two null characters.
   (Python handles this termination automatically.)

.. data:: REG_NONE

   No defined value type.

662 663 664 665
.. data:: REG_QWORD

   A 64-bit number.

666 667
   .. versionadded:: 3.6

668 669 670 671
.. data:: REG_QWORD_LITTLE_ENDIAN

   A 64-bit number in little-endian format. Equivalent to :const:`REG_QWORD`.

672 673
   .. versionadded:: 3.6

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
.. data:: REG_RESOURCE_LIST

   A device-driver resource list.

.. data:: REG_FULL_RESOURCE_DESCRIPTOR

   A hardware setting.

.. data:: REG_RESOURCE_REQUIREMENTS_LIST

   A hardware resource list.

.. data:: REG_SZ

   A null-terminated string.


691 692 693 694 695 696 697
.. _handle-object:

Registry Handle Objects
-----------------------

This object wraps a Windows HKEY object, automatically closing it when the
object is destroyed.  To guarantee cleanup, you can call either the
698
:meth:`~PyHKEY.Close` method on the object, or the :func:`CloseKey` function.
699 700 701

All registry functions in this module return one of these objects.

702 703
All registry functions in this module which accept a handle object also accept
an integer, however, use of the handle object is encouraged.
704

705
Handle objects provide semantics for :meth:`__bool__` -- thus ::
706 707

   if handle:
708
       print("Yes")
709 710 711 712 713 714 715

will print ``Yes`` if the handle is currently valid (has not been closed or
detached).

The object also support comparison semantics, so handle objects will compare
true if they both reference the same underlying Windows handle value.

716
Handle objects can be converted to an integer (e.g., using the built-in
717
:func:`int` function), in which case the underlying Windows handle value is
718 719
returned.  You can also use the :meth:`~PyHKEY.Detach` method to return the
integer handle, and also disconnect the Windows handle from the handle object.
720 721 722 723 724 725 726 727 728 729 730 731 732


.. method:: PyHKEY.Close()

   Closes the underlying Windows handle.

   If the handle is already closed, no error is raised.


.. method:: PyHKEY.Detach()

   Detaches the Windows handle from the handle object.

733 734 735
   The result is an integer that holds the value of the handle before it is
   detached.  If the handle is already detached or closed, this will return
   zero.
736 737

   After calling this function, the handle is effectively invalidated, but the
738 739
   handle is not closed.  You would call this function when you need the
   underlying Win32 handle to exist beyond the lifetime of the handle object.
740

741 742 743
.. method:: PyHKEY.__enter__()
            PyHKEY.__exit__(\*exc_info)

744 745 746
   The HKEY object implements :meth:`~object.__enter__` and
   :meth:`~object.__exit__` and thus supports the context protocol for the
   :keyword:`with` statement::
747 748

      with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
749
          ...  # work with key
750 751 752 753

   will automatically close *key* when control leaves the :keyword:`with` block.