[Python-checkins] r80472 - in python/branches/py3k: Doc/library/winreg.rst
ezio.melotti
python-checkins at python.org
Sun Apr 25 19:48:01 CEST 2010
Author: ezio.melotti
Date: Sun Apr 25 19:48:01 2010
New Revision: 80472
Log:
Merged revisions 79786 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r79786 | ezio.melotti | 2010-04-05 11:02:54 +0300 (Mon, 05 Apr 2010) | 1 line
Fix markup, punctuation and whitespaces in _winreg.rst.
........
Modified:
python/branches/py3k/ (props changed)
python/branches/py3k/Doc/library/winreg.rst
Modified: python/branches/py3k/Doc/library/winreg.rst
==============================================================================
--- python/branches/py3k/Doc/library/winreg.rst (original)
+++ python/branches/py3k/Doc/library/winreg.rst Sun Apr 25 19:48:01 2010
@@ -13,7 +13,7 @@
close them.
This module exposes a very low-level interface to the Windows registry; it is
-expected that in the future a new ``winreg`` module will be created offering a
+expected that in the future a new ``winreg`` module will be created offering a
higher-level interface to the registry API.
This module offers the following functions:
@@ -31,39 +31,41 @@
.. function:: ConnectRegistry(computer_name, key)
- Establishes a connection to a predefined registry handle on another computer,
- and returns a :dfn:`handle object`
+ Establishes a connection to a predefined registry handle on another computer,
+ and returns a :ref:`handle object <handle-object>`.
- *computer_name* is the name of the remote computer, of the form
+ *computer_name* is the name of the remote computer, of the form
``r"\\computername"``. If ``None``, the local computer is used.
*key* is the predefined handle to connect to.
The return value is the handle of the opened key. If the function fails, a
- :exc:`WindowsError` exception is raised.
+ :exc:`WindowsError` exception is raised.
.. function:: CreateKey(key, sub_key)
- Creates or opens the specified key, returning a :dfn:`handle object`
+ Creates or opens the specified key, returning a
+ :ref:`handle object <handle-object>`.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
- *sub_key* is a string that names the key this method opens or creates.
+ *sub_key* is a string that names the key this method opens or creates.
- 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.
+ 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.
If the key already exists, this function opens the existing key.
The return value is the handle of the opened key. If the function fails, a
- :exc:`WindowsError` exception is raised.
+ :exc:`WindowsError` exception is raised.
.. function:: CreateKeyEx(key, sub_key[, res[, sam]])
- Creates or opens the specified key, returning a :dfn:`handle object`
+ Creates or opens the specified key, returning a
+ :ref:`handle object <handle-object>`.
*key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
@@ -75,8 +77,8 @@
*sam* is an integer that specifies an access mask that describes the desired
security access for the key. Default is :const:`KEY_ALL_ACCESS`
- 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.
+ 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.
If the key already exists, this function opens the existing key.
@@ -99,7 +101,7 @@
*This method can not delete keys with subkeys.*
If the method succeeds, the entire key, including all of its values, is removed.
- If the method fails, a :exc:`WindowsError` exception is raised.
+ If the method fails, a :exc:`WindowsError` exception is raised.
.. function:: DeleteKeyEx(key, sub_key[, sam[, res]])
@@ -137,7 +139,7 @@
Removes a named value from a registry key.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
*value* is a string that identifies the value to remove.
@@ -147,13 +149,13 @@
Enumerates subkeys of an open registry key, returning a string.
- *key* is an already open key, or any one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or any one of the predefined :const:`HKEY_\*`
constants.
- *index* is an integer that identifies the index of the key to retrieve.
+ *index* is an integer that identifies the index of the key to retrieve.
- The function retrieves the name of one subkey each time it is called. It is
- typically called repeatedly until a :exc:`WindowsError` exception is
+ The function retrieves the name of one subkey each time it is called. It is
+ typically called repeatedly until a :exc:`WindowsError` exception is
raised, indicating, no more values are available.
@@ -161,14 +163,14 @@
Enumerates values of an open registry key, returning a tuple.
- *key* is an already open key, or any one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or any one of the predefined :const:`HKEY_\*`
constants.
- *index* is an integer that identifies the index of the value to retrieve.
+ *index* is an integer that identifies the index of the value to retrieve.
- The function retrieves the name of one subkey each time it is called. It is
- typically called repeatedly, until a :exc:`WindowsError` exception is
- raised, indicating no more values.
+ The function retrieves the name of one subkey each time it is called. It is
+ typically called repeatedly, until a :exc:`WindowsError` exception is
+ raised, indicating no more values.
The result is a tuple of 3 items:
@@ -198,25 +200,25 @@
Writes all the attributes of a key to the registry.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
It is not necessary to call :func:`FlushKey` to change a key. Registry changes are
- 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
+ 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
registry. An application should only call :func:`FlushKey` if it requires
- absolute certainty that registry changes are on disk.
+ absolute certainty that registry changes are on disk.
.. note::
- If you don't know whether a :func:`FlushKey` call is required, it probably
+ If you don't know whether a :func:`FlushKey` call is required, it probably
isn't.
.. function:: LoadKey(key, sub_key, file_name)
- Creates a subkey under the specified key and stores registration information
+ Creates a subkey under the specified key and stores registration information
from a specified file into that subkey.
*key* is an already open key, or any of the predefined :const:`HKEY_\*`
@@ -230,18 +232,18 @@
A call to LoadKey() fails if the calling process does not have the
:const:`SE_RESTORE_PRIVILEGE` privilege. Note that privileges are different than
- permissions - see the Win32 documentation for more details.
+ permissions -- see the Win32 documentation for more details.
- If *key* is a handle returned by :func:`ConnectRegistry`, then the path
- specified in *fileName* is relative to the remote computer.
+ If *key* is a handle returned by :func:`ConnectRegistry`, then the path
+ specified in *fileName* is relative to the remote computer.
- The Win32 documentation implies *key* must be in the :const:`HKEY_USER` or
+ The Win32 documentation implies *key* must be in the :const:`HKEY_USER` or
:const:`HKEY_LOCAL_MACHINE` tree. This may or may not be true.
.. function:: OpenKey(key, sub_key[, res[, sam]])
- Opens the specified key, returning a :dfn:`handle object`
+ Opens the specified key, returning a :ref:`handle object <handle-object>`.
*key* is an already open key, or any one of the predefined :const:`HKEY_\*`
constants.
@@ -250,7 +252,7 @@
*res* is a reserved integer, and must be zero. The default is zero.
- *sam* is an integer that specifies an access mask that describes the desired
+ *sam* is an integer that specifies an access mask that describes the desired
security access for the key. Default is :const:`KEY_READ`.
The result is a new handle to the specified key.
@@ -260,15 +262,15 @@
.. function:: OpenKeyEx()
- The functionality of :func:`OpenKeyEx` is provided via :func:`OpenKey`, by the
- use of default arguments.
+ The functionality of :func:`OpenKeyEx` is provided via :func:`OpenKey`,
+ by the use of default arguments.
.. function:: QueryInfoKey(key)
Returns information about a key, as a tuple.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
The result is a tuple of 3 items:
@@ -290,14 +292,14 @@
.. function:: QueryValue(key, sub_key)
- Retrieves the unnamed value for a key, as a string
+ Retrieves the unnamed value for a key, as a string.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
- *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*.
+ *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*.
Values in the registry have name, type, and data components. This method
retrieves the data for a key's first value that has a NULL name. But the
@@ -307,10 +309,10 @@
.. function:: QueryValueEx(key, value_name)
- Retrieves the type and data for a specified value name associated with an open
- registry key.
+ Retrieves the type and data for a specified value name associated with
+ an open registry key.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
*value_name* is a string indicating the value to query.
@@ -331,18 +333,18 @@
Saves the specified key, and all its subkeys to the specified file.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
*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`, :meth:`ReplaceKey`
- or :meth:`RestoreKey` methods.
+ or :meth:`RestoreKey` methods.
- If *key* represents a key on a remote computer, the path described by
+ If *key* represents a key on a remote computer, the path described by
*file_name* is relative to the remote computer. The caller of this method must
- possess the :const:`SeBackupPrivilege` security privilege. Note that
- privileges are different than permissions - see the Win32 documentation for
+ possess the :const:`SeBackupPrivilege` security privilege. Note that
+ privileges are different than permissions -- see the Win32 documentation for
more details.
This function passes NULL for *security_attributes* to the API.
@@ -352,10 +354,10 @@
Associates a value with a specified key.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
- *sub_key* is a string that names the subkey with which the value is associated.
+ *sub_key* is a string that names the subkey with which the value is associated.
*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`
@@ -370,7 +372,7 @@
bytes) should be stored as files with the filenames stored in the configuration
registry. This helps the registry perform efficiently.
- The key identified by the *key* parameter must have been opened with
+ The key identified by the *key* parameter must have been opened with
:const:`KEY_SET_VALUE` access.
@@ -378,13 +380,13 @@
Stores data in the value field of an open registry key.
- *key* is an already open key, or one of the predefined :const:`HKEY_\*`
+ *key* is an already open key, or one of the predefined :const:`HKEY_\*`
constants.
- *value_name* is a string that names the subkey with which the value is
+ *value_name* is a string that names the subkey with which the value is
associated.
- *type* is an integer that specifies the type of the data. This should be one
+ *type* is an integer that specifies the type of the data. This should be one
of the following constants defined in this module:
+----------------------------------+---------------------------------------------+
@@ -406,7 +408,7 @@
+----------------------------------+---------------------------------------------+
| :const:`REG_MULTI_SZ` | A sequence of null-terminated strings, |
| | terminated by two null characters. (Python |
- | | handles this termination automatically.) |
+ | | handles this termination automatically.) |
+----------------------------------+---------------------------------------------+
| :const:`REG_NONE` | No defined value type. |
+----------------------------------+---------------------------------------------+
@@ -415,7 +417,7 @@
| :const:`REG_SZ` | A null-terminated string. |
+----------------------------------+---------------------------------------------+
- *reserved* can be anything - zero is always passed to the API.
+ *reserved* can be anything -- zero is always passed to the API.
*value* is a string that specifies the new value.
@@ -423,7 +425,7 @@
key. The key identified by the key parameter must have been opened with
:const:`KEY_SET_VALUE` access.
- To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods.
+ To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods.
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
@@ -479,14 +481,14 @@
This object wraps a Windows HKEY object, automatically closing it when the
object is destroyed. To guarantee cleanup, you can call either the
-:meth:`Close` method on the object, or the :func:`CloseKey` function.
+:meth:`Close` method on the object, or the :func:`CloseKey` function.
All registry functions in this module return one of these objects.
-All registry functions in this module which accept a handle object also accept
-an integer, however, use of the handle object is encouraged.
+All registry functions in this module which accept a handle object also accept
+an integer, however, use of the handle object is encouraged.
-Handle objects provide semantics for :meth:`__bool__` - thus ::
+Handle objects provide semantics for :meth:`__bool__` -- thus ::
if handle:
print("Yes")
@@ -499,7 +501,7 @@
Handle objects can be converted to an integer (e.g., using the built-in
:func:`int` function), in which case the underlying Windows handle value is
-returned. You can also use the :meth:`Detach` method to return the integer
+returned. You can also use the :meth:`Detach` method to return the integer
handle, and also disconnect the Windows handle from the handle object.
@@ -519,8 +521,8 @@
zero.
After calling this function, the handle is effectively invalidated, but the
- 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.
+ 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.
.. method:: PyHKEY.__enter__()
PyHKEY.__exit__(\*exc_info)
More information about the Python-checkins
mailing list