FM / library

/usr/share/doc/python2-docs/html/_sources/library/

/usr/share/doc/python2-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	edit dl rm
abc.rst.txt	7219	0644	edit dl rm
aepack.rst.txt	4257	0644	edit dl rm
aetools.rst.txt	3532	0644	edit dl rm
aetypes.rst.txt	4257	0644	edit dl rm
aifc.rst.txt	7086	0644	edit dl rm
al.rst.txt	5309	0644	edit dl rm
allos.rst.txt	695	0644	edit dl rm
anydbm.rst.txt	4111	0644	edit dl rm
archiving.rst.txt	424	0644	edit dl rm
argparse.rst.txt	74685	0644	edit dl rm
array.rst.txt	10524	0644	edit dl rm
ast.rst.txt	10111	0644	edit dl rm
asynchat.rst.txt	9206	0644	edit dl rm
asyncore.rst.txt	12937	0644	edit dl rm
atexit.rst.txt	3910	0644	edit dl rm
audioop.rst.txt	10395	0644	edit dl rm
autogil.rst.txt	1015	0644	edit dl rm
base64.rst.txt	6252	0644	edit dl rm
basehttpserver.rst.txt	10404	0644	edit dl rm
bastion.rst.txt	2611	0644	edit dl rm
bdb.rst.txt	12456	0644	edit dl rm
binascii.rst.txt	6508	0644	edit dl rm
binhex.rst.txt	1910	0644	edit dl rm
bisect.rst.txt	5415	0644	edit dl rm
bsddb.rst.txt	7575	0644	edit dl rm
bz2.rst.txt	8064	0644	edit dl rm
calendar.rst.txt	11282	0644	edit dl rm
carbon.rst.txt	15956	0644	edit dl rm
cd.rst.txt	11974	0644	edit dl rm
cgi.rst.txt	22853	0644	edit dl rm
cgihttpserver.rst.txt	2788	0644	edit dl rm
cgitb.rst.txt	2874	0644	edit dl rm
chunk.rst.txt	4955	0644	edit dl rm
cmath.rst.txt	7647	0644	edit dl rm
cmd.rst.txt	8565	0644	edit dl rm
code.rst.txt	7115	0644	edit dl rm
codecs.rst.txt	66966	0644	edit dl rm
codeop.rst.txt	3774	0644	edit dl rm
collections.rst.txt	41448	0644	edit dl rm
colorpicker.rst.txt	913	0644	edit dl rm
colorsys.rst.txt	1819	0644	edit dl rm
commands.rst.txt	2595	0644	edit dl rm
compileall.rst.txt	4678	0644	edit dl rm
compiler.rst.txt	37464	0644	edit dl rm
configparser.rst.txt	19607	0644	edit dl rm
constants.rst.txt	2328	0644	edit dl rm
contextlib.rst.txt	6012	0644	edit dl rm
cookie.rst.txt	9543	0644	edit dl rm
cookielib.rst.txt	27875	0644	edit dl rm
copy.rst.txt	3351	0644	edit dl rm
copy_reg.rst.txt	2329	0644	edit dl rm
crypt.rst.txt	2292	0644	edit dl rm
crypto.rst.txt	355	0644	edit dl rm
csv.rst.txt	22757	0644	edit dl rm
ctypes.rst.txt	90513	0644	edit dl rm
curses.ascii.rst.txt	9046	0644	edit dl rm
curses.panel.rst.txt	2740	0644	edit dl rm
curses.rst.txt	74877	0644	edit dl rm
custominterp.rst.txt	570	0644	edit dl rm
datatypes.rst.txt	864	0644	edit dl rm
datetime.rst.txt	74679	0644	edit dl rm
dbhash.rst.txt	3865	0644	edit dl rm
dbm.rst.txt	3117	0644	edit dl rm
debug.rst.txt	446	0644	edit dl rm
decimal.rst.txt	70926	0644	edit dl rm
development.rst.txt	640	0644	edit dl rm
difflib.rst.txt	30716	0644	edit dl rm
dircache.rst.txt	1813	0644	edit dl rm
dis.rst.txt	23248	0644	edit dl rm
distribution.rst.txt	426	0644	edit dl rm
distutils.rst.txt	1958	0644	edit dl rm
dl.rst.txt	3392	0644	edit dl rm
doctest.rst.txt	73985	0644	edit dl rm
docxmlrpcserver.rst.txt	3802	0644	edit dl rm
dumbdbm.rst.txt	2841	0644	edit dl rm
dummy_thread.rst.txt	1058	0644	edit dl rm
dummy_threading.rst.txt	799	0644	edit dl rm
easydialogs.rst.txt	10346	0644	edit dl rm
email-examples.rst.txt	1271	0644	edit dl rm
email.charset.rst.txt	9654	0644	edit dl rm
email.encoders.rst.txt	2376	0644	edit dl rm
email.errors.rst.txt	4006	0644	edit dl rm
email.generator.rst.txt	6132	0644	edit dl rm
email.header.rst.txt	7531	0644	edit dl rm
email.iterators.rst.txt	2421	0644	edit dl rm
email.message.rst.txt	25217	0644	edit dl rm
email.mime.rst.txt	9917	0644	edit dl rm
email.parser.rst.txt	10327	0644	edit dl rm
email.rst.txt	16111	0644	edit dl rm
email.utils.rst.txt	6475	0644	edit dl rm
ensurepip.rst.txt	5022	0644	edit dl rm
errno.rst.txt	6708	0644	edit dl rm
exceptions.rst.txt	18343	0644	edit dl rm
fcntl.rst.txt	7361	0644	edit dl rm
filecmp.rst.txt	5348	0644	edit dl rm
fileformats.rst.txt	302	0644	edit dl rm
fileinput.rst.txt	7417	0644	edit dl rm
filesys.rst.txt	806	0644	edit dl rm
fl.rst.txt	17646	0644	edit dl rm
fm.rst.txt	2699	0644	edit dl rm
fnmatch.rst.txt	3104	0644	edit dl rm
formatter.rst.txt	13245	0644	edit dl rm
fpectl.rst.txt	4171	0644	edit dl rm
fpformat.rst.txt	1747	0644	edit dl rm
fractions.rst.txt	5297	0644	edit dl rm
framework.rst.txt	11444	0644	edit dl rm
frameworks.rst.txt	378	0644	edit dl rm
ftplib.rst.txt	15720	0644	edit dl rm
functions.rst.txt	75554	0644	edit dl rm
functools.rst.txt	7448	0644	edit dl rm
future_builtins.rst.txt	2010	0644	edit dl rm
gc.rst.txt	9014	0644	edit dl rm
gdbm.rst.txt	4882	0644	edit dl rm
gensuitemodule.rst.txt	3113	0644	edit dl rm
getopt.rst.txt	6670	0644	edit dl rm
getpass.rst.txt	1876	0644	edit dl rm
gettext.rst.txt	29040	0644	edit dl rm
gl.rst.txt	6009	0644	edit dl rm
glob.rst.txt	2414	0644	edit dl rm
grp.rst.txt	2256	0644	edit dl rm
gzip.rst.txt	4828	0644	edit dl rm
hashlib.rst.txt	7379	0644	edit dl rm
heapq.rst.txt	13185	0644	edit dl rm
hmac.rst.txt	3073	0644	edit dl rm
hotshot.rst.txt	4289	0644	edit dl rm
htmllib.rst.txt	7379	0644	edit dl rm
htmlparser.rst.txt	11640	0644	edit dl rm
httplib.rst.txt	37454	0644	edit dl rm
i18n.rst.txt	409	0644	edit dl rm
ic.rst.txt	5005	0644	edit dl rm
idle.rst.txt	22182	0644	edit dl rm
imageop.rst.txt	4001	0644	edit dl rm
imaplib.rst.txt	17221	0644	edit dl rm
imgfile.rst.txt	2765	0644	edit dl rm
imghdr.rst.txt	2635	0644	edit dl rm
imp.rst.txt	12593	0644	edit dl rm
importlib.rst.txt	1126	0644	edit dl rm
imputil.rst.txt	7023	0644	edit dl rm
index.rst.txt	2287	0644	edit dl rm
inspect.rst.txt	28151	0644	edit dl rm
internet.rst.txt	950	0644	edit dl rm
intro.rst.txt	2803	0644	edit dl rm
io.rst.txt	39015	0644	edit dl rm
ipc.rst.txt	630	0644	edit dl rm
itertools.rst.txt	36324	0644	edit dl rm
jpeg.rst.txt	3858	0644	edit dl rm
json.rst.txt	25545	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	523	0644	edit dl rm
linecache.rst.txt	1887	0644	edit dl rm
locale.rst.txt	24975	0644	edit dl rm
logging.config.rst.txt	31560	0644	edit dl rm
logging.handlers.rst.txt	28153	0644	edit dl rm
logging.rst.txt	46882	0644	edit dl rm
mac.rst.txt	791	0644	edit dl rm
macos.rst.txt	3824	0644	edit dl rm
macosa.rst.txt	3964	0644	edit dl rm
macostools.rst.txt	4017	0644	edit dl rm
macpath.rst.txt	650	0644	edit dl rm
mailbox.rst.txt	68129	0644	edit dl rm
mailcap.rst.txt	3675	0644	edit dl rm
markup.rst.txt	1249	0644	edit dl rm
marshal.rst.txt	5689	0644	edit dl rm
math.rst.txt	10920	0644	edit dl rm
md5.rst.txt	2815	0644	edit dl rm
mhlib.rst.txt	3966	0644	edit dl rm
mimetools.rst.txt	4504	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
mimewriter.rst.txt	3360	0644	edit dl rm
mimify.rst.txt	3519	0644	edit dl rm
miniaeframe.rst.txt	2564	0644	edit dl rm
misc.rst.txt	248	0644	edit dl rm
mm.rst.txt	447	0644	edit dl rm
mmap.rst.txt	10481	0644	edit dl rm
modulefinder.rst.txt	3380	0644	edit dl rm
modules.rst.txt	382	0644	edit dl rm
msilib.rst.txt	19062	0644	edit dl rm
msvcrt.rst.txt	4346	0644	edit dl rm
multifile.rst.txt	6613	0644	edit dl rm
multiprocessing.rst.txt	92621	0644	edit dl rm
mutex.rst.txt	1939	0644	edit dl rm
netdata.rst.txt	432	0644	edit dl rm
netrc.rst.txt	3119	0644	edit dl rm
new.rst.txt	2653	0644	edit dl rm
nis.rst.txt	2108	0644	edit dl rm
nntplib.rst.txt	14531	0644	edit dl rm
numbers.rst.txt	8007	0644	edit dl rm
numeric.rst.txt	751	0644	edit dl rm
operator.rst.txt	22092	0644	edit dl rm
optparse.rst.txt	77101	0644	edit dl rm
os.path.rst.txt	13094	0644	edit dl rm
os.rst.txt	82580	0644	edit dl rm
ossaudiodev.rst.txt	17309	0644	edit dl rm
othergui.rst.txt	2721	0644	edit dl rm
parser.rst.txt	15385	0644	edit dl rm
pdb.rst.txt	16043	0644	edit dl rm
persistence.rst.txt	826	0644	edit dl rm
pickle.rst.txt	37262	0644	edit dl rm
pickletools.rst.txt	1997	0644	edit dl rm
pipes.rst.txt	3786	0644	edit dl rm
pkgutil.rst.txt	7714	0644	edit dl rm
platform.rst.txt	9554	0644	edit dl rm
plistlib.rst.txt	4134	0644	edit dl rm
popen2.rst.txt	7022	0644	edit dl rm
poplib.rst.txt	6220	0644	edit dl rm
posix.rst.txt	3630	0644	edit dl rm
posixfile.rst.txt	7200	0644	edit dl rm
pprint.rst.txt	9071	0644	edit dl rm
profile.rst.txt	28666	0644	edit dl rm
pty.rst.txt	1762	0644	edit dl rm
pwd.rst.txt	2725	0644	edit dl rm
pyclbr.rst.txt	3296	0644	edit dl rm
pydoc.rst.txt	4083	0644	edit dl rm
pyexpat.rst.txt	28891	0644	edit dl rm
python.rst.txt	514	0644	edit dl rm
py_compile.rst.txt	2479	0644	edit dl rm
queue.rst.txt	7034	0644	edit dl rm
quopri.rst.txt	2670	0644	edit dl rm
random.rst.txt	13319	0644	edit dl rm
re.rst.txt	55102	0644	edit dl rm
readline.rst.txt	10513	0644	edit dl rm
repr.rst.txt	4718	0644	edit dl rm
resource.rst.txt	9595	0644	edit dl rm
restricted.rst.txt	3327	0644	edit dl rm
rexec.rst.txt	11742	0644	edit dl rm
rfc822.rst.txt	14037	0644	edit dl rm
rlcompleter.rst.txt	2494	0644	edit dl rm
robotparser.rst.txt	2190	0644	edit dl rm
runpy.rst.txt	6938	0644	edit dl rm
sched.rst.txt	4644	0644	edit dl rm
scrolledtext.rst.txt	1379	0644	edit dl rm
select.rst.txt	20705	0644	edit dl rm
sets.rst.txt	14973	0644	edit dl rm
sgi.rst.txt	322	0644	edit dl rm
sgmllib.rst.txt	10664	0644	edit dl rm
sha.rst.txt	2807	0644	edit dl rm
shelve.rst.txt	8319	0644	edit dl rm
shlex.rst.txt	11313	0644	edit dl rm
shutil.rst.txt	13491	0644	edit dl rm
signal.rst.txt	10719	0644	edit dl rm
simplehttpserver.rst.txt	4559	0644	edit dl rm
simplexmlrpcserver.rst.txt	10881	0644	edit dl rm
site.rst.txt	7880	0644	edit dl rm
smtpd.rst.txt	2464	0644	edit dl rm
smtplib.rst.txt	14906	0644	edit dl rm
sndhdr.rst.txt	1759	0644	edit dl rm
socket.rst.txt	40765	0644	edit dl rm
socketserver.rst.txt	22512	0644	edit dl rm
someos.rst.txt	599	0644	edit dl rm
spwd.rst.txt	2825	0644	edit dl rm
sqlite3.rst.txt	35448	0644	edit dl rm
ssl.rst.txt	76554	0644	edit dl rm
stat.rst.txt	7778	0644	edit dl rm
statvfs.rst.txt	1300	0644	edit dl rm
stdtypes.rst.txt	122668	0644	edit dl rm
string.rst.txt	44085	0644	edit dl rm
stringio.rst.txt	4166	0644	edit dl rm
stringprep.rst.txt	4238	0644	edit dl rm
strings.rst.txt	746	0644	edit dl rm
struct.rst.txt	17100	0644	edit dl rm
subprocess.rst.txt	33648	0644	edit dl rm
sun.rst.txt	249	0644	edit dl rm
sunau.rst.txt	7124	0644	edit dl rm
sunaudio.rst.txt	5849	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	5064	0644	edit dl rm
sys.rst.txt	47520	0644	edit dl rm
sysconfig.rst.txt	7639	0644	edit dl rm
syslog.rst.txt	3931	0644	edit dl rm
tabnanny.rst.txt	1999	0644	edit dl rm
tarfile.rst.txt	28214	0644	edit dl rm
telnetlib.rst.txt	7482	0644	edit dl rm
tempfile.rst.txt	10504	0644	edit dl rm
termios.rst.txt	3733	0644	edit dl rm
test.rst.txt	17659	0644	edit dl rm
textwrap.rst.txt	8552	0644	edit dl rm
thread.rst.txt	6588	0644	edit dl rm
threading.rst.txt	32468	0644	edit dl rm
time.rst.txt	26020	0644	edit dl rm
timeit.rst.txt	11598	0644	edit dl rm
tix.rst.txt	22693	0644	edit dl rm
tk.rst.txt	1612	0644	edit dl rm
tkinter.rst.txt	33456	0644	edit dl rm
token.rst.txt	2451	0644	edit dl rm
tokenize.rst.txt	5570	0644	edit dl rm
trace.rst.txt	6724	0644	edit dl rm
traceback.rst.txt	10711	0644	edit dl rm
ttk.rst.txt	57411	0644	edit dl rm
tty.rst.txt	1011	0644	edit dl rm
turtle.rst.txt	64097	0644	edit dl rm
types.rst.txt	6200	0644	edit dl rm
undoc.rst.txt	6550	0644	edit dl rm
unicodedata.rst.txt	5736	0644	edit dl rm
unittest.rst.txt	82952	0644	edit dl rm
unix.rst.txt	490	0644	edit dl rm
urllib.rst.txt	24960	0644	edit dl rm
urllib2.rst.txt	35211	0644	edit dl rm
urlparse.rst.txt	16071	0644	edit dl rm
user.rst.txt	2748	0644	edit dl rm
userdict.rst.txt	9290	0644	edit dl rm
uu.rst.txt	2369	0644	edit dl rm
uuid.rst.txt	8378	0644	edit dl rm
warnings.rst.txt	19815	0644	edit dl rm
wave.rst.txt	5047	0644	edit dl rm
weakref.rst.txt	12926	0644	edit dl rm
webbrowser.rst.txt	9863	0644	edit dl rm
whichdb.rst.txt	931	0644	edit dl rm
windows.rst.txt	273	0644	edit dl rm
winsound.rst.txt	5066	0644	edit dl rm
wsgiref.rst.txt	30567	0644	edit dl rm
xdrlib.rst.txt	8077	0644	edit dl rm
xml.dom.minidom.rst.txt	11208	0644	edit dl rm
xml.dom.pulldom.rst.txt	1571	0644	edit dl rm
xml.dom.rst.txt	40182	0644	edit dl rm
xml.etree.elementtree.rst.txt	35707	0644	edit dl rm
xml.rst.txt	6090	0644	edit dl rm
xml.sax.handler.rst.txt	15371	0644	edit dl rm
xml.sax.reader.rst.txt	12257	0644	edit dl rm
xml.sax.rst.txt	6460	0644	edit dl rm
xml.sax.utils.rst.txt	3560	0644	edit dl rm
xmlrpclib.rst.txt	22559	0644	edit dl rm
zipfile.rst.txt	18871	0644	edit dl rm
zipimport.rst.txt	5957	0644	edit dl rm
zlib.rst.txt	12766	0644	edit dl rm
_winreg.rst.txt	23305	0644	edit dl rm
__builtin__.rst.txt	1494	0644	edit dl rm
__future__.rst.txt	4952	0644	edit dl rm
__main__.rst.txt	535	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/library/_winreg.rst.txt (23305B)

:mod:`_winreg` --- Windows registry access
==========================================

.. module:: _winreg
   :platform: Windows
   :synopsis: Routines and objects for manipulating the Windows registry.
.. sectionauthor:: Mark Hammond <MarkH@ActiveState.com>

.. note::
   The :mod:`_winreg` module has been renamed to :mod:`winreg` in Python 3.
   The :term:`2to3` tool will automatically adapt imports when converting your
   sources to Python 3.

.. versionadded:: 2.0

These functions expose the Windows registry API to Python.  Instead of using an
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.

This module offers the following functions:

.. function:: CloseKey(hkey)

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

.. note::
      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.

.. function:: ConnectRegistry(computer_name, key)

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
   ``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.

.. function:: CreateKey(key, sub_key)

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

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

*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 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.

.. function:: CreateKeyEx(key, sub_key[, res[, sam]])

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

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

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

*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
   security access for the key.  Default is :const:`KEY_ALL_ACCESS`.  See
   :ref:`Access Rights <access-rights>` for other allowed values.

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.

.. versionadded:: 2.7

.. function:: DeleteKey(key, sub_key)

Deletes the specified key.

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

*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.

*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.

.. function:: DeleteKeyEx(key, sub_key[, sam[, res]])

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.
      See the `RegDeleteKeyEx documentation
      <http://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx>`__.

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

*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.

*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
   security access for the key.  Default is :const:`KEY_WOW64_64KEY`.  See
   :ref:`Access Rights <access-rights>` for other allowed values.

*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.

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

.. versionadded:: 2.7

.. function:: DeleteValue(key, value)

Removes a named value from a registry key.

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

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

.. function:: EnumKey(key, index)

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

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

*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
   raised, indicating, no more values are available.

.. function:: EnumValue(key, index)

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

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

*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 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 |
   |       | value data (see table in docs for          |
   |       | :meth:`SetValueEx`)                        |
   +-------+--------------------------------------------+

.. function:: ExpandEnvironmentStrings(unicode)

Expands environment variable placeholders ``%NAME%`` in unicode strings like
   :const:`REG_EXPAND_SZ`::

>>> ExpandEnvironmentStrings(u"%windir%")
      u"C:\\Windows"

.. versionadded:: 2.6

.. function:: FlushKey(key)

Writes all the attributes of a key to the registry.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <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
   registry. An application should only call :func:`FlushKey` if it requires
   absolute certainty that registry changes are on disk.

.. note::

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
   from a specified file into that subkey.

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

*sub_key* is a string that identifies the subkey to load.

*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.

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

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

.. function:: OpenKey(key, sub_key[, res[, sam]])

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

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

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

*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
   security access for the key.  Default is :const:`KEY_READ`.  See
   :ref:`Access Rights <access-rights>` for other allowed values.

The result is a new handle to the specified key.

If the function fails, :exc:`WindowsError` is raised.

.. function:: OpenKeyEx()

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
   :ref:`HKEY_* constants <hkey-constants>`.

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.                                    |
   +-------+---------------------------------------------+
   | ``2`` | A long integer giving when the key was last |
   |       | modified (if available) as 100's of         |
   |       | nanoseconds since Jan 1, 1601.              |
   +-------+---------------------------------------------+

.. function:: QueryValue(key, sub_key)

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

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <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*.

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
   underlying API call doesn't return the type, so always use
   :func:`QueryValueEx` if possible.

.. function:: QueryValueEx(key, value_name)

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
   :ref:`HKEY_* constants <hkey-constants>`.

*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 |
   |       | this value (see table in docs for       |
   |       | :meth:`SetValueEx`)                     |
   +-------+-----------------------------------------+

.. function:: SaveKey(key, file_name)

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

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <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`
   method.

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
   `Conflicts Between User Rights and Permissions documentation
   <http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__
   for more details.

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

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

Associates a value with a specified key.

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

*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`
   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.

The key identified by the *key* parameter must have been opened with
   :const:`KEY_SET_VALUE` access.

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

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

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

*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. See
   :ref:`Value Types <value-types>` for the available types.

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

*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.

To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods.

.. function:: DisableReflectionKey(key)

Disables registry reflection for 32-bit processes running on a 64-bit
   operating system.

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

Will generally raise :exc:`NotImplemented` if executed on a 32-bit
   operating system.

If the key is not on the reflection list, the function succeeds but has no
   effect. Disabling reflection for a key does not affect reflection of any
   subkeys.

.. function:: EnableReflectionKey(key)

Restores registry reflection for the specified disabled key.

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

Will generally raise :exc:`NotImplemented` if executed on a 32-bit
   operating system.

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

.. function:: QueryReflectionKey(key)

Determines the reflection state for the specified key.

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

Returns ``True`` if reflection is disabled.

Will generally raise :exc:`NotImplemented` if executed on a 32-bit
   operating system.

.. _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
<http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__.

.. 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
***************

For more information, see `Accessing an Alternate Registry View
<http://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx>`__.

.. 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
<http://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx>`__.

.. data:: REG_BINARY

Binary data in any form.

.. data:: REG_DWORD

32-bit number.

.. data:: REG_DWORD_LITTLE_ENDIAN

A 32-bit number in little-endian format.

.. 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.

.. 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.

.. _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
:meth:`~PyHKEY.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.

Handle objects provide semantics for :meth:`__nonzero__` -- thus::

if handle:
       print "Yes"

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.

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:`~PyHKEY.Detach` method to return the
integer handle, and also disconnect the Windows handle from the handle object.

.. 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.

The result is an integer (or long on 64 bit Windows) that holds the value of the
   handle before it is detached.  If the handle is already detached or closed, this
   will return 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.

.. method:: PyHKEY.__enter__()
            PyHKEY.__exit__(\*exc_info)

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

with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
          ...  # work with key

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

.. versionadded:: 2.6

:mod:`_winreg` --- Windows registry access ========================================== .. module:: _winreg :platform: Windows :synopsis: Routines and objects for manipulating the Windows registry. .. sectionauthor:: Mark Hammond .. note:: The :mod:`_winreg` module has been renamed to :mod:`winreg` in Python 3. The :term:`2to3` tool will automatically adapt imports when converting your sources to Python 3. .. versionadded:: 2.0 These functions expose the Windows registry API to Python. Instead of using an integer as the registry handle, a :ref:`handle object ` is used to ensure that the handles are closed correctly, even if the programmer neglects to explicitly close them. This module offers the following functions: .. function:: CloseKey(hkey) Closes a previously opened registry key. The *hkey* argument specifies a previously opened key. .. note:: If *hkey* is not closed using this method (or via :meth:`hkey.Close() `), it is closed when the *hkey* object is destroyed by Python. .. function:: ConnectRegistry(computer_name, key) Establishes a connection to a predefined registry handle on another computer, and returns a :ref:`handle object `. *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. .. function:: CreateKey(key, sub_key) Creates or opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *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 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. .. function:: CreateKeyEx(key, sub_key[, res[, sam]]) Creates or opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that names the key this method opens or creates. *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 security access for the key. Default is :const:`KEY_ALL_ACCESS`. See :ref:`Access Rights ` for other allowed values. 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. .. versionadded:: 2.7 .. function:: DeleteKey(key, sub_key) Deletes the specified key. *key* is an already open key, or any one of the predefined :ref:`HKEY_* constants `. *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. *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. .. function:: DeleteKeyEx(key, sub_key[, sam[, res]]) 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. See the `RegDeleteKeyEx documentation `__. *key* is an already open key, or any one of the predefined :ref:`HKEY_* constants `. *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. *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 security access for the key. Default is :const:`KEY_WOW64_64KEY`. See :ref:`Access Rights ` for other allowed values. *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. On unsupported Windows versions, :exc:`NotImplementedError` is raised. .. versionadded:: 2.7 .. function:: DeleteValue(key, value) Removes a named value from a registry key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *value* is a string that identifies the value to remove. .. function:: EnumKey(key, index) Enumerates subkeys of an open registry key, returning a string. *key* is an already open key, or any one of the predefined :ref:`HKEY_* constants `. *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 raised, indicating, no more values are available. .. function:: EnumValue(key, index) Enumerates values of an open registry key, returning a tuple. *key* is an already open key, or any one of the predefined :ref:`HKEY_* constants `. *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 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 | | | value data (see table in docs for | | | :meth:`SetValueEx`) | +-------+--------------------------------------------+ .. function:: ExpandEnvironmentStrings(unicode) Expands environment variable placeholders ``%NAME%`` in unicode strings like :const:`REG_EXPAND_SZ`:: >>> ExpandEnvironmentStrings(u"%windir%") u"C:\\Windows" .. versionadded:: 2.6 .. function:: FlushKey(key) Writes all the attributes of a key to the registry. *key* is an already open key, or one of the predefined :ref:`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 registry. An application should only call :func:`FlushKey` if it requires absolute certainty that registry changes are on disk. .. note:: 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 from a specified file into that subkey. *key* is a handle returned by :func:`ConnectRegistry` or one of the constants :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`. *sub_key* is a string that identifies the subkey to load. *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. A call to :func:`LoadKey` fails if the calling process does not have the :const:`SE_RESTORE_PRIVILEGE` privilege. Note that privileges are different from permissions -- see the `RegLoadKey documentation `__ for more details. If *key* is a handle returned by :func:`ConnectRegistry`, then the path specified in *file_name* is relative to the remote computer. .. function:: OpenKey(key, sub_key[, res[, sam]]) Opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or any one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that identifies the sub_key to open. *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 security access for the key. Default is :const:`KEY_READ`. See :ref:`Access Rights ` for other allowed values. The result is a new handle to the specified key. If the function fails, :exc:`WindowsError` is raised. .. function:: OpenKeyEx() 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 :ref:`HKEY_* constants `. 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. | +-------+---------------------------------------------+ | ``2`` | A long integer giving when the key was last | | | modified (if available) as 100's of | | | nanoseconds since Jan 1, 1601. | +-------+---------------------------------------------+ .. function:: QueryValue(key, sub_key) Retrieves the unnamed value for a key, as a string. *key* is an already open key, or one of the predefined :ref:`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*. 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 underlying API call doesn't return the type, so always use :func:`QueryValueEx` if possible. .. function:: QueryValueEx(key, value_name) 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 :ref:`HKEY_* constants `. *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 | | | this value (see table in docs for | | | :meth:`SetValueEx`) | +-------+-----------------------------------------+ .. function:: SaveKey(key, file_name) Saves the specified key, and all its subkeys to the specified file. *key* is an already open key, or one of the predefined :ref:`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` method. 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 `Conflicts Between User Rights and Permissions documentation `__ for more details. This function passes NULL for *security_attributes* to the API. .. function:: SetValue(key, sub_key, type, value) Associates a value with a specified key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *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` 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. The key identified by the *key* parameter must have been opened with :const:`KEY_SET_VALUE` access. .. function:: SetValueEx(key, value_name, reserved, type, value) Stores data in the value field of an open registry key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *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. See :ref:`Value Types ` for the available types. *reserved* can be anything -- zero is always passed to the API. *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. 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 registry. This helps the registry perform efficiently. .. function:: DisableReflectionKey(key) Disables registry reflection for 32-bit processes running on a 64-bit operating system. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. If the key is not on the reflection list, the function succeeds but has no effect. Disabling reflection for a key does not affect reflection of any subkeys. .. function:: EnableReflectionKey(key) Restores registry reflection for the specified disabled key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. Restoring reflection for a key does not affect reflection of any subkeys. .. function:: QueryReflectionKey(key) Determines the reflection state for the specified key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Returns ``True`` if reflection is disabled. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. .. _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 `__. .. 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 *************** For more information, see `Accessing an Alternate Registry View `__. .. 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 `__. .. data:: REG_BINARY Binary data in any form. .. data:: REG_DWORD 32-bit number. .. data:: REG_DWORD_LITTLE_ENDIAN A 32-bit number in little-endian format. .. 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. .. 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. .. _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 :meth:`~PyHKEY.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. Handle objects provide semantics for :meth:`__nonzero__` -- thus:: if handle: print "Yes" 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. 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:`~PyHKEY.Detach` method to return the integer handle, and also disconnect the Windows handle from the handle object. .. 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. The result is an integer (or long on 64 bit Windows) that holds the value of the handle before it is detached. If the handle is already detached or closed, this will return 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. .. method:: PyHKEY.__enter__() PyHKEY.__exit__(\*exc_info) The HKEY object implements :meth:`~object.__enter__` and :meth:`~object.__exit__` and thus supports the context protocol for the :keyword:`with` statement:: with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: ... # work with key will automatically close *key* when control leaves the :keyword:`with` block. .. versionadded:: 2.6