/
usr
/
share
/
doc
/
python2-docs
/
html
/
library
/
/usr/share/doc/python2-docs/html/library
mkdir
upload
Name
Size
Mode
Actions
2to3.html
59507
0644
edit
dl
rm
abc.html
25826
0644
edit
dl
rm
aepack.html
14164
0644
edit
dl
rm
aetools.html
16389
0644
edit
dl
rm
aetypes.html
21021
0644
edit
dl
rm
aifc.html
25064
0644
edit
dl
rm
al.html
18672
0644
edit
dl
rm
allos.html
35297
0644
edit
dl
rm
anydbm.html
18124
0644
edit
dl
rm
archiving.html
10078
0644
edit
dl
rm
argparse.html
263616
0644
edit
dl
rm
array.html
31855
0644
edit
dl
rm
ast.html
38167
0644
edit
dl
rm
asynchat.html
33930
0644
edit
dl
rm
asyncore.html
40631
0644
edit
dl
rm
atexit.html
18455
0644
edit
dl
rm
audioop.html
34252
0644
edit
dl
rm
autogil.html
8733
0644
edit
dl
rm
base64.html
21862
0644
edit
dl
rm
basehttpserver.html
37441
0644
edit
dl
rm
bastion.html
11798
0644
edit
dl
rm
bdb.html
41395
0644
edit
dl
rm
binascii.html
22997
0644
edit
dl
rm
binhex.html
11309
0644
edit
dl
rm
bisect.html
24666
0644
edit
dl
rm
bsddb.html
28589
0644
edit
dl
rm
bz2.html
29048
0644
edit
dl
rm
calendar.html
41762
0644
edit
dl
rm
carbon.html
51998
0644
edit
dl
rm
cd.html
30033
0644
edit
dl
rm
cgi.html
55922
0644
edit
dl
rm
cgihttpserver.html
14026
0644
edit
dl
rm
cgitb.html
12263
0644
edit
dl
rm
chunk.html
15899
0644
edit
dl
rm
cmath.html
28365
0644
edit
dl
rm
cmd.html
29042
0644
edit
dl
rm
code.html
26959
0644
edit
dl
rm
codecs.html
118258
0644
edit
dl
rm
codeop.html
15898
0644
edit
dl
rm
collections.html
147647
0644
edit
dl
rm
colorpicker.html
8035
0644
edit
dl
rm
colorsys.html
11919
0644
edit
dl
rm
commands.html
15516
0644
edit
dl
rm
compileall.html
18621
0644
edit
dl
rm
compiler.html
75897
0644
edit
dl
rm
configparser.html
67751
0644
edit
dl
rm
constants.html
13979
0644
edit
dl
rm
contextlib.html
22777
0644
edit
dl
rm
cookie.html
41854
0644
edit
dl
rm
cookielib.html
91032
0644
edit
dl
rm
copy.html
13004
0644
edit
dl
rm
copy_reg.html
14691
0644
edit
dl
rm
crypt.html
10647
0644
edit
dl
rm
crypto.html
7761
0644
edit
dl
rm
csv.html
76456
0644
edit
dl
rm
ctypes.html
264575
0644
edit
dl
rm
curses.ascii.html
24873
0644
edit
dl
rm
curses.html
167501
0644
edit
dl
rm
curses.panel.html
15824
0644
edit
dl
rm
custominterp.html
8026
0644
edit
dl
rm
datatypes.html
18015
0644
edit
dl
rm
datetime.html
253438
0644
edit
dl
rm
dbhash.html
16825
0644
edit
dl
rm
dbm.html
13507
0644
edit
dl
rm
debug.html
10703
0644
edit
dl
rm
decimal.html
222315
0644
edit
dl
rm
development.html
14828
0644
edit
dl
rm
difflib.html
91975
0644
edit
dl
rm
dircache.html
12299
0644
edit
dl
rm
dis.html
84156
0644
edit
dl
rm
distribution.html
7679
0644
edit
dl
rm
distutils.html
10152
0644
edit
dl
rm
dl.html
17668
0644
edit
dl
rm
doctest.html
185883
0644
edit
dl
rm
docxmlrpcserver.html
17573
0644
edit
dl
rm
dumbdbm.html
15549
0644
edit
dl
rm
dummy_thread.html
10065
0644
edit
dl
rm
dummy_threading.html
8934
0644
edit
dl
rm
easydialogs.html
33124
0644
edit
dl
rm
email-examples.html
47424
0644
edit
dl
rm
email.charset.html
29424
0644
edit
dl
rm
email.encoders.html
12847
0644
edit
dl
rm
email.errors.html
17952
0644
edit
dl
rm
email.generator.html
23141
0644
edit
dl
rm
email.header.html
29108
0644
edit
dl
rm
email.html
55722
0644
edit
dl
rm
email.iterators.html
12623
0644
edit
dl
rm
email.message.html
70189
0644
edit
dl
rm
email.mime.html
31655
0644
edit
dl
rm
email.parser.html
35142
0644
edit
dl
rm
email.utils.html
27076
0644
edit
dl
rm
ensurepip.html
18327
0644
edit
dl
rm
errno.html
40246
0644
edit
dl
rm
exceptions.html
63693
0644
edit
dl
rm
fcntl.html
26245
0644
edit
dl
rm
filecmp.html
23997
0644
edit
dl
rm
fileformats.html
9653
0644
edit
dl
rm
fileinput.html
27071
0644
edit
dl
rm
filesys.html
10866
0644
edit
dl
rm
fl.html
56525
0644
edit
dl
rm
fm.html
13009
0644
edit
dl
rm
fnmatch.html
16258
0644
edit
dl
rm
formatter.html
37371
0644
edit
dl
rm
fpectl.html
16879
0644
edit
dl
rm
fpformat.html
11455
0644
edit
dl
rm
fractions.html
24888
0644
edit
dl
rm
framework.html
36934
0644
edit
dl
rm
frameworks.html
7551
0644
edit
dl
rm
ftplib.html
49577
0644
edit
dl
rm
functions.html
205640
0644
edit
dl
rm
functools.html
29645
0644
edit
dl
rm
future_builtins.html
14477
0644
edit
dl
rm
gc.html
28423
0644
edit
dl
rm
gdbm.html
17805
0644
edit
dl
rm
gensuitemodule.html
12574
0644
edit
dl
rm
getopt.html
25280
0644
edit
dl
rm
getpass.html
11426
0644
edit
dl
rm
gettext.html
84971
0644
edit
dl
rm
gl.html
24342
0644
edit
dl
rm
glob.html
14430
0644
edit
dl
rm
grp.html
11316
0644
edit
dl
rm
gzip.html
20576
0644
edit
dl
rm
hashlib.html
25467
0644
edit
dl
rm
heapq.html
34890
0644
edit
dl
rm
hmac.html
14374
0644
edit
dl
rm
hotshot.html
20147
0644
edit
dl
rm
htmllib.html
27682
0644
edit
dl
rm
htmlparser.html
42433
0644
edit
dl
rm
httplib.html
70932
0644
edit
dl
rm
i18n.html
10047
0644
edit
dl
rm
ic.html
18654
0644
edit
dl
rm
idle.html
42148
0644
edit
dl
rm
imageop.html
16099
0644
edit
dl
rm
imaplib.html
58515
0644
edit
dl
rm
imgfile.html
12732
0644
edit
dl
rm
imghdr.html
12238
0644
edit
dl
rm
imp.html
37603
0644
edit
dl
rm
importlib.html
8926
0644
edit
dl
rm
imputil.html
33563
0644
edit
dl
rm
index.html
79088
0644
edit
dl
rm
inspect.html
56823
0644
edit
dl
rm
internet.html
26138
0644
edit
dl
rm
intro.html
9353
0644
edit
dl
rm
io.html
113701
0644
edit
dl
rm
ipc.html
16598
0644
edit
dl
rm
itertools.html
125397
0644
edit
dl
rm
jpeg.html
13757
0644
edit
dl
rm
json.html
73678
0644
edit
dl
rm
keyword.html
8210
0644
edit
dl
rm
language.html
11687
0644
edit
dl
rm
linecache.html
11416
0644
edit
dl
rm
locale.html
61576
0644
edit
dl
rm
logging.config.html
80045
0644
edit
dl
rm
logging.handlers.html
80194
0644
edit
dl
rm
logging.html
110254
0644
edit
dl
rm
mac.html
23376
0644
edit
dl
rm
macos.html
16129
0644
edit
dl
rm
macosa.html
14080
0644
edit
dl
rm
macostools.html
16898
0644
edit
dl
rm
macpath.html
8386
0644
edit
dl
rm
mailbox.html
171121
0644
edit
dl
rm
mailcap.html
14132
0644
edit
dl
rm
markup.html
19862
0644
edit
dl
rm
marshal.html
19456
0644
edit
dl
rm
math.html
44015
0644
edit
dl
rm
md5.html
15123
0644
edit
dl
rm
mhlib.html
24123
0644
edit
dl
rm
mimetools.html
21206
0644
edit
dl
rm
mimetypes.html
30634
0644
edit
dl
rm
mimewriter.html
16078
0644
edit
dl
rm
mimify.html
15279
0644
edit
dl
rm
miniaeframe.html
13109
0644
edit
dl
rm
misc.html
7236
0644
edit
dl
rm
mm.html
9570
0644
edit
dl
rm
mmap.html
30832
0644
edit
dl
rm
modulefinder.html
18096
0644
edit
dl
rm
modules.html
9017
0644
edit
dl
rm
msilib.html
57853
0644
edit
dl
rm
msvcrt.html
21232
0644
edit
dl
rm
multifile.html
26256
0644
edit
dl
rm
multiprocessing.html
414535
0644
edit
dl
rm
mutex.html
12147
0644
edit
dl
rm
netdata.html
18379
0644
edit
dl
rm
netrc.html
14021
0644
edit
dl
rm
new.html
13177
0644
edit
dl
rm
nis.html
11502
0644
edit
dl
rm
nntplib.html
45689
0644
edit
dl
rm
numbers.html
40636
0644
edit
dl
rm
numeric.html
14292
0644
edit
dl
rm
operator.html
93622
0644
edit
dl
rm
optparse.html
250109
0644
edit
dl
rm
os.html
240195
0644
edit
dl
rm
os.path.html
43402
0644
edit
dl
rm
ossaudiodev.html
45594
0644
edit
dl
rm
othergui.html
9403
0644
edit
dl
rm
parser.html
42558
0644
edit
dl
rm
pdb.html
38603
0644
edit
dl
rm
persistence.html
15676
0644
edit
dl
rm
pickle.html
109684
0644
edit
dl
rm
pickletools.html
11475
0644
edit
dl
rm
pipes.html
19685
0644
edit
dl
rm
pkgutil.html
27367
0644
edit
dl
rm
platform.html
31599
0644
edit
dl
rm
plistlib.html
18344
0644
edit
dl
rm
popen2.html
27601
0644
edit
dl
rm
poplib.html
24320
0644
edit
dl
rm
posix.html
16626
0644
edit
dl
rm
posixfile.html
21387
0644
edit
dl
rm
pprint.html
32207
0644
edit
dl
rm
profile.html
72788
0644
edit
dl
rm
pty.html
10195
0644
edit
dl
rm
pwd.html
12388
0644
edit
dl
rm
pyclbr.html
15812
0644
edit
dl
rm
pydoc.html
13650
0644
edit
dl
rm
pyexpat.html
80886
0644
edit
dl
rm
python.html
12854
0644
edit
dl
rm
py_compile.html
11932
0644
edit
dl
rm
queue.html
26856
0644
edit
dl
rm
quopri.html
12739
0644
edit
dl
rm
random.html
42722
0644
edit
dl
rm
re.html
155985
0644
edit
dl
rm
readline.html
37383
0644
edit
dl
rm
repr.html
21778
0644
edit
dl
rm
resource.html
28286
0644
edit
dl
rm
restricted.html
12366
0644
edit
dl
rm
rexec.html
40566
0644
edit
dl
rm
rfc822.html
46408
0644
edit
dl
rm
rlcompleter.html
14460
0644
edit
dl
rm
robotparser.html
13403
0644
edit
dl
rm
runpy.html
21925
0644
edit
dl
rm
sched.html
19878
0644
edit
dl
rm
scrolledtext.html
9728
0644
edit
dl
rm
select.html
44090
0644
edit
dl
rm
sets.html
40151
0644
edit
dl
rm
sgi.html
10371
0644
edit
dl
rm
sgmllib.html
34464
0644
edit
dl
rm
sha.html
13062
0644
edit
dl
rm
shelve.html
29955
0644
edit
dl
rm
shlex.html
35033
0644
edit
dl
rm
shutil.html
45454
0644
edit
dl
rm
signal.html
34023
0644
edit
dl
rm
simplehttpserver.html
20351
0644
edit
dl
rm
simplexmlrpcserver.html
37794
0644
edit
dl
rm
site.html
26887
0644
edit
dl
rm
smtpd.html
13587
0644
edit
dl
rm
smtplib.html
47054
0644
edit
dl
rm
sndhdr.html
10993
0644
edit
dl
rm
socket.html
116414
0644
edit
dl
rm
socketserver.html
76430
0644
edit
dl
rm
someos.html
16472
0644
edit
dl
rm
spwd.html
11163
0644
edit
dl
rm
sqlite3.html
150014
0644
edit
dl
rm
ssl.html
202453
0644
edit
dl
rm
stat.html
34597
0644
edit
dl
rm
statvfs.html
11326
0644
edit
dl
rm
stdtypes.html
298144
0644
edit
dl
rm
string.html
120219
0644
edit
dl
rm
stringio.html
20061
0644
edit
dl
rm
stringprep.html
17729
0644
edit
dl
rm
strings.html
15905
0644
edit
dl
rm
struct.html
44896
0644
edit
dl
rm
subprocess.html
110447
0644
edit
dl
rm
sun.html
7253
0644
edit
dl
rm
sunau.html
30011
0644
edit
dl
rm
sunaudio.html
19236
0644
edit
dl
rm
symbol.html
8140
0644
edit
dl
rm
symtable.html
25871
0644
edit
dl
rm
sys.html
110996
0644
edit
dl
rm
sysconfig.html
26299
0644
edit
dl
rm
syslog.html
19737
0644
edit
dl
rm
tabnanny.html
11393
0644
edit
dl
rm
tarfile.html
88728
0644
edit
dl
rm
telnetlib.html
27782
0644
edit
dl
rm
tempfile.html
31903
0644
edit
dl
rm
termios.html
17309
0644
edit
dl
rm
test.html
57030
0644
edit
dl
rm
textwrap.html
30135
0644
edit
dl
rm
thread.html
21486
0644
edit
dl
rm
threading.html
86655
0644
edit
dl
rm
time.html
63798
0644
edit
dl
rm
timeit.html
40529
0644
edit
dl
rm
tix.html
50582
0644
edit
dl
rm
tk.html
26568
0644
edit
dl
rm
tkinter.html
84316
0644
edit
dl
rm
token.html
20999
0644
edit
dl
rm
tokenize.html
20607
0644
edit
dl
rm
trace.html
28668
0644
edit
dl
rm
traceback.html
40900
0644
edit
dl
rm
ttk.html
108515
0644
edit
dl
rm
tty.html
9753
0644
edit
dl
rm
turtle.html
230483
0644
edit
dl
rm
types.html
29833
0644
edit
dl
rm
undoc.html
24680
0644
edit
dl
rm
unicodedata.html
20186
0644
edit
dl
rm
unittest.html
225021
0644
edit
dl
rm
unix.html
11223
0644
edit
dl
rm
urllib.html
68266
0644
edit
dl
rm
urllib2.html
113380
0644
edit
dl
rm
urlparse.html
43474
0644
edit
dl
rm
user.html
12707
0644
edit
dl
rm
userdict.html
32069
0644
edit
dl
rm
uu.html
11810
0644
edit
dl
rm
uuid.html
30137
0644
edit
dl
rm
warnings.html
50950
0644
edit
dl
rm
wave.html
24894
0644
edit
dl
rm
weakref.html
38808
0644
edit
dl
rm
webbrowser.html
26565
0644
edit
dl
rm
whichdb.html
9499
0644
edit
dl
rm
windows.html
9817
0644
edit
dl
rm
winsound.html
20466
0644
edit
dl
rm
wsgiref.html
88384
0644
edit
dl
rm
xdrlib.html
33018
0644
edit
dl
rm
xml.dom.html
97877
0644
edit
dl
rm
xml.dom.minidom.html
43230
0644
edit
dl
rm
xml.dom.pulldom.html
13835
0644
edit
dl
rm
xml.etree.elementtree.html
111804
0644
edit
dl
rm
xml.html
18007
0644
edit
dl
rm
xml.sax.handler.html
41877
0644
edit
dl
rm
xml.sax.html
23458
0644
edit
dl
rm
xml.sax.reader.html
44802
0644
edit
dl
rm
xml.sax.utils.html
16087
0644
edit
dl
rm
xmlrpclib.html
69191
0644
edit
dl
rm
zipfile.html
62227
0644
edit
dl
rm
zipimport.html
22769
0644
edit
dl
rm
zlib.html
31230
0644
edit
dl
rm
_winreg.html
64631
0644
edit
dl
rm
__builtin__.html
11069
0644
edit
dl
rm
__future__.html
14688
0644
edit
dl
rm
__main__.html
7512
0644
edit
dl
rm
Edit:
/usr/share/doc/python2-docs/html/library/_winreg.html
(64631B)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>35.3. _winreg — Windows registry access — Python 2.7.16 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.16 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="35.4. winsound — Sound-playing interface for Windows" href="winsound.html" /> <link rel="prev" title="35.2. msvcrt — Useful routines from the MS VC++ runtime" href="msvcrt.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/2/library/_winreg.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="winsound.html" title="35.4. winsound — Sound-playing interface for Windows" accesskey="N">next</a> |</li> <li class="right" > <a href="msvcrt.html" title="35.2. msvcrt — Useful routines from the MS VC++ runtime" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="windows.html" accesskey="U">35. MS Windows Specific Services</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-_winreg"> <span id="winreg-windows-registry-access"></span><h1>35.3. <a class="reference internal" href="#module-_winreg" title="_winreg: Routines and objects for manipulating the Windows registry. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">_winreg</span></code></a> — Windows registry access<a class="headerlink" href="#module-_winreg" title="Permalink to this headline">¶</a></h1> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The <a class="reference internal" href="#module-_winreg" title="_winreg: Routines and objects for manipulating the Windows registry. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">_winreg</span></code></a> module has been renamed to <code class="xref py py-mod docutils literal notranslate"><span class="pre">winreg</span></code> in Python 3. The <a class="reference internal" href="../glossary.html#term-2to3"><span class="xref std std-term">2to3</span></a> tool will automatically adapt imports when converting your sources to Python 3.</p> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 2.0.</span></p> </div> <p>These functions expose the Windows registry API to Python. Instead of using an integer as the registry handle, a <a class="reference internal" href="#handle-object"><span class="std std-ref">handle object</span></a> is used to ensure that the handles are closed correctly, even if the programmer neglects to explicitly close them.</p> <p>This module offers the following functions:</p> <dl class="function"> <dt id="_winreg.CloseKey"> <code class="descclassname">_winreg.</code><code class="descname">CloseKey</code><span class="sig-paren">(</span><em>hkey</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.CloseKey" title="Permalink to this definition">¶</a></dt> <dd><p>Closes a previously opened registry key. The <em>hkey</em> argument specifies a previously opened key.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If <em>hkey</em> is not closed using this method (or via <a class="reference internal" href="#_winreg.PyHKEY.Close" title="_winreg.PyHKEY.Close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">hkey.Close()</span></code></a>), it is closed when the <em>hkey</em> object is destroyed by Python.</p> </div> </dd></dl> <dl class="function"> <dt id="_winreg.ConnectRegistry"> <code class="descclassname">_winreg.</code><code class="descname">ConnectRegistry</code><span class="sig-paren">(</span><em>computer_name</em>, <em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.ConnectRegistry" title="Permalink to this definition">¶</a></dt> <dd><p>Establishes a connection to a predefined registry handle on another computer, and returns a <a class="reference internal" href="#handle-object"><span class="std std-ref">handle object</span></a>.</p> <p><em>computer_name</em> is the name of the remote computer, of the form <code class="docutils literal notranslate"><span class="pre">r"\\computername"</span></code>. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the local computer is used.</p> <p><em>key</em> is the predefined handle to connect to.</p> <p>The return value is the handle of the opened key. If the function fails, a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised.</p> </dd></dl> <dl class="function"> <dt id="_winreg.CreateKey"> <code class="descclassname">_winreg.</code><code class="descname">CreateKey</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.CreateKey" title="Permalink to this definition">¶</a></dt> <dd><p>Creates or opens the specified key, returning a <a class="reference internal" href="#handle-object"><span class="std std-ref">handle object</span></a>.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that names the key this method opens or creates.</p> <p>If <em>key</em> is one of the predefined keys, <em>sub_key</em> may be <code class="docutils literal notranslate"><span class="pre">None</span></code>. In that case, the handle returned is the same key handle passed in to the function.</p> <p>If the key already exists, this function opens the existing key.</p> <p>The return value is the handle of the opened key. If the function fails, a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised.</p> </dd></dl> <dl class="function"> <dt id="_winreg.CreateKeyEx"> <code class="descclassname">_winreg.</code><code class="descname">CreateKeyEx</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="optional">[</span>, <em>res</em><span class="optional">[</span>, <em>sam</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.CreateKeyEx" title="Permalink to this definition">¶</a></dt> <dd><p>Creates or opens the specified key, returning a <a class="reference internal" href="#handle-object"><span class="std std-ref">handle object</span></a>.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that names the key this method opens or creates.</p> <p><em>res</em> is a reserved integer, and must be zero. The default is zero.</p> <p><em>sam</em> is an integer that specifies an access mask that describes the desired security access for the key. Default is <a class="reference internal" href="#_winreg.KEY_ALL_ACCESS" title="_winreg.KEY_ALL_ACCESS"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_ALL_ACCESS</span></code></a>. See <a class="reference internal" href="#access-rights"><span class="std std-ref">Access Rights</span></a> for other allowed values.</p> <p>If <em>key</em> is one of the predefined keys, <em>sub_key</em> may be <code class="docutils literal notranslate"><span class="pre">None</span></code>. In that case, the handle returned is the same key handle passed in to the function.</p> <p>If the key already exists, this function opens the existing key.</p> <p>The return value is the handle of the opened key. If the function fails, a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised.</p> </dd></dl> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> <dl class="function"> <dt id="_winreg.DeleteKey"> <code class="descclassname">_winreg.</code><code class="descname">DeleteKey</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.DeleteKey" title="Permalink to this definition">¶</a></dt> <dd><p>Deletes the specified key.</p> <p><em>key</em> is an already open key, or any one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that must be a subkey of the key identified by the <em>key</em> parameter. This value must not be <code class="docutils literal notranslate"><span class="pre">None</span></code>, and the key may not have subkeys.</p> <p><em>This method can not delete keys with subkeys.</em></p> <p>If the method succeeds, the entire key, including all of its values, is removed. If the method fails, a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised.</p> </dd></dl> <dl class="function"> <dt id="_winreg.DeleteKeyEx"> <code class="descclassname">_winreg.</code><code class="descname">DeleteKeyEx</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="optional">[</span>, <em>sam</em><span class="optional">[</span>, <em>res</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.DeleteKeyEx" title="Permalink to this definition">¶</a></dt> <dd><p>Deletes the specified key.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The <a class="reference internal" href="#_winreg.DeleteKeyEx" title="_winreg.DeleteKeyEx"><code class="xref py py-func docutils literal notranslate"><span class="pre">DeleteKeyEx()</span></code></a> function is implemented with the RegDeleteKeyEx Windows API function, which is specific to 64-bit versions of Windows. See the <a class="reference external" href="http://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx">RegDeleteKeyEx documentation</a>.</p> </div> <p><em>key</em> is an already open key, or any one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that must be a subkey of the key identified by the <em>key</em> parameter. This value must not be <code class="docutils literal notranslate"><span class="pre">None</span></code>, and the key may not have subkeys.</p> <p><em>res</em> is a reserved integer, and must be zero. The default is zero.</p> <p><em>sam</em> is an integer that specifies an access mask that describes the desired security access for the key. Default is <a class="reference internal" href="#_winreg.KEY_WOW64_64KEY" title="_winreg.KEY_WOW64_64KEY"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_WOW64_64KEY</span></code></a>. See <a class="reference internal" href="#access-rights"><span class="std std-ref">Access Rights</span></a> for other allowed values.</p> <p><em>This method can not delete keys with subkeys.</em></p> <p>If the method succeeds, the entire key, including all of its values, is removed. If the method fails, a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised.</p> <p>On unsupported Windows versions, <a class="reference internal" href="exceptions.html#exceptions.NotImplementedError" title="exceptions.NotImplementedError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NotImplementedError</span></code></a> is raised.</p> </dd></dl> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> <dl class="function"> <dt id="_winreg.DeleteValue"> <code class="descclassname">_winreg.</code><code class="descname">DeleteValue</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.DeleteValue" title="Permalink to this definition">¶</a></dt> <dd><p>Removes a named value from a registry key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>value</em> is a string that identifies the value to remove.</p> </dd></dl> <dl class="function"> <dt id="_winreg.EnumKey"> <code class="descclassname">_winreg.</code><code class="descname">EnumKey</code><span class="sig-paren">(</span><em>key</em>, <em>index</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.EnumKey" title="Permalink to this definition">¶</a></dt> <dd><p>Enumerates subkeys of an open registry key, returning a string.</p> <p><em>key</em> is an already open key, or any one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>index</em> is an integer that identifies the index of the key to retrieve.</p> <p>The function retrieves the name of one subkey each time it is called. It is typically called repeatedly until a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised, indicating, no more values are available.</p> </dd></dl> <dl class="function"> <dt id="_winreg.EnumValue"> <code class="descclassname">_winreg.</code><code class="descname">EnumValue</code><span class="sig-paren">(</span><em>key</em>, <em>index</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.EnumValue" title="Permalink to this definition">¶</a></dt> <dd><p>Enumerates values of an open registry key, returning a tuple.</p> <p><em>key</em> is an already open key, or any one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>index</em> is an integer that identifies the index of the value to retrieve.</p> <p>The function retrieves the name of one subkey each time it is called. It is typically called repeatedly, until a <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> exception is raised, indicating no more values.</p> <p>The result is a tuple of 3 items:</p> <table border="1" class="docutils"> <colgroup> <col width="14%" /> <col width="86%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Index</th> <th class="head">Meaning</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">0</span></code></td> <td>A string that identifies the value name</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">1</span></code></td> <td>An object that holds the value data, and whose type depends on the underlying registry type</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">2</span></code></td> <td>An integer that identifies the type of the value data (see table in docs for <a class="reference internal" href="#_winreg.SetValueEx" title="_winreg.SetValueEx"><code class="xref py py-meth docutils literal notranslate"><span class="pre">SetValueEx()</span></code></a>)</td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="_winreg.ExpandEnvironmentStrings"> <code class="descclassname">_winreg.</code><code class="descname">ExpandEnvironmentStrings</code><span class="sig-paren">(</span><em>unicode</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.ExpandEnvironmentStrings" title="Permalink to this definition">¶</a></dt> <dd><p>Expands environment variable placeholders <code class="docutils literal notranslate"><span class="pre">%NAME%</span></code> in unicode strings like <a class="reference internal" href="#_winreg.REG_EXPAND_SZ" title="_winreg.REG_EXPAND_SZ"><code class="xref py py-const docutils literal notranslate"><span class="pre">REG_EXPAND_SZ</span></code></a>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">ExpandEnvironmentStrings</span><span class="p">(</span><span class="sa">u</span><span class="s2">"%windir%"</span><span class="p">)</span> <span class="go">u"C:\\Windows"</span> </pre></div> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="function"> <dt id="_winreg.FlushKey"> <code class="descclassname">_winreg.</code><code class="descname">FlushKey</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.FlushKey" title="Permalink to this definition">¶</a></dt> <dd><p>Writes all the attributes of a key to the registry.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p>It is not necessary to call <a class="reference internal" href="#_winreg.FlushKey" title="_winreg.FlushKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">FlushKey()</span></code></a> 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 <a class="reference internal" href="#_winreg.CloseKey" title="_winreg.CloseKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">CloseKey()</span></code></a>, the <a class="reference internal" href="#_winreg.FlushKey" title="_winreg.FlushKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">FlushKey()</span></code></a> method returns only when all the data has been written to the registry. An application should only call <a class="reference internal" href="#_winreg.FlushKey" title="_winreg.FlushKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">FlushKey()</span></code></a> if it requires absolute certainty that registry changes are on disk.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If you don’t know whether a <a class="reference internal" href="#_winreg.FlushKey" title="_winreg.FlushKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">FlushKey()</span></code></a> call is required, it probably isn’t.</p> </div> </dd></dl> <dl class="function"> <dt id="_winreg.LoadKey"> <code class="descclassname">_winreg.</code><code class="descname">LoadKey</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.LoadKey" title="Permalink to this definition">¶</a></dt> <dd><p>Creates a subkey under the specified key and stores registration information from a specified file into that subkey.</p> <p><em>key</em> is a handle returned by <a class="reference internal" href="#_winreg.ConnectRegistry" title="_winreg.ConnectRegistry"><code class="xref py py-func docutils literal notranslate"><span class="pre">ConnectRegistry()</span></code></a> or one of the constants <a class="reference internal" href="#_winreg.HKEY_USERS" title="_winreg.HKEY_USERS"><code class="xref py py-const docutils literal notranslate"><span class="pre">HKEY_USERS</span></code></a> or <a class="reference internal" href="#_winreg.HKEY_LOCAL_MACHINE" title="_winreg.HKEY_LOCAL_MACHINE"><code class="xref py py-const docutils literal notranslate"><span class="pre">HKEY_LOCAL_MACHINE</span></code></a>.</p> <p><em>sub_key</em> is a string that identifies the subkey to load.</p> <p><em>file_name</em> is the name of the file to load registry data from. This file must have been created with the <a class="reference internal" href="#_winreg.SaveKey" title="_winreg.SaveKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">SaveKey()</span></code></a> function. Under the file allocation table (FAT) file system, the filename may not have an extension.</p> <p>A call to <a class="reference internal" href="#_winreg.LoadKey" title="_winreg.LoadKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">LoadKey()</span></code></a> fails if the calling process does not have the <code class="xref py py-const docutils literal notranslate"><span class="pre">SE_RESTORE_PRIVILEGE</span></code> privilege. Note that privileges are different from permissions – see the <a class="reference external" href="http://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx">RegLoadKey documentation</a> for more details.</p> <p>If <em>key</em> is a handle returned by <a class="reference internal" href="#_winreg.ConnectRegistry" title="_winreg.ConnectRegistry"><code class="xref py py-func docutils literal notranslate"><span class="pre">ConnectRegistry()</span></code></a>, then the path specified in <em>file_name</em> is relative to the remote computer.</p> </dd></dl> <dl class="function"> <dt id="_winreg.OpenKey"> <code class="descclassname">_winreg.</code><code class="descname">OpenKey</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="optional">[</span>, <em>res</em><span class="optional">[</span>, <em>sam</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.OpenKey" title="Permalink to this definition">¶</a></dt> <dd><p>Opens the specified key, returning a <a class="reference internal" href="#handle-object"><span class="std std-ref">handle object</span></a>.</p> <p><em>key</em> is an already open key, or any one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that identifies the sub_key to open.</p> <p><em>res</em> is a reserved integer, and must be zero. The default is zero.</p> <p><em>sam</em> is an integer that specifies an access mask that describes the desired security access for the key. Default is <a class="reference internal" href="#_winreg.KEY_READ" title="_winreg.KEY_READ"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_READ</span></code></a>. See <a class="reference internal" href="#access-rights"><span class="std std-ref">Access Rights</span></a> for other allowed values.</p> <p>The result is a new handle to the specified key.</p> <p>If the function fails, <a class="reference internal" href="exceptions.html#exceptions.WindowsError" title="exceptions.WindowsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">WindowsError</span></code></a> is raised.</p> </dd></dl> <dl class="function"> <dt id="_winreg.OpenKeyEx"> <code class="descclassname">_winreg.</code><code class="descname">OpenKeyEx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.OpenKeyEx" title="Permalink to this definition">¶</a></dt> <dd><p>The functionality of <a class="reference internal" href="#_winreg.OpenKeyEx" title="_winreg.OpenKeyEx"><code class="xref py py-func docutils literal notranslate"><span class="pre">OpenKeyEx()</span></code></a> is provided via <a class="reference internal" href="#_winreg.OpenKey" title="_winreg.OpenKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">OpenKey()</span></code></a>, by the use of default arguments.</p> </dd></dl> <dl class="function"> <dt id="_winreg.QueryInfoKey"> <code class="descclassname">_winreg.</code><code class="descname">QueryInfoKey</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.QueryInfoKey" title="Permalink to this definition">¶</a></dt> <dd><p>Returns information about a key, as a tuple.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p>The result is a tuple of 3 items:</p> <table border="1" class="docutils"> <colgroup> <col width="13%" /> <col width="87%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Index</th> <th class="head">Meaning</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">0</span></code></td> <td>An integer giving the number of sub keys this key has.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">1</span></code></td> <td>An integer giving the number of values this key has.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">2</span></code></td> <td>A long integer giving when the key was last modified (if available) as 100’s of nanoseconds since Jan 1, 1601.</td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="_winreg.QueryValue"> <code class="descclassname">_winreg.</code><code class="descname">QueryValue</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.QueryValue" title="Permalink to this definition">¶</a></dt> <dd><p>Retrieves the unnamed value for a key, as a string.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that holds the name of the subkey with which the value is associated. If this parameter is <code class="docutils literal notranslate"><span class="pre">None</span></code> or empty, the function retrieves the value set by the <a class="reference internal" href="#_winreg.SetValue" title="_winreg.SetValue"><code class="xref py py-func docutils literal notranslate"><span class="pre">SetValue()</span></code></a> method for the key identified by <em>key</em>.</p> <p>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 <a class="reference internal" href="#_winreg.QueryValueEx" title="_winreg.QueryValueEx"><code class="xref py py-func docutils literal notranslate"><span class="pre">QueryValueEx()</span></code></a> if possible.</p> </dd></dl> <dl class="function"> <dt id="_winreg.QueryValueEx"> <code class="descclassname">_winreg.</code><code class="descname">QueryValueEx</code><span class="sig-paren">(</span><em>key</em>, <em>value_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.QueryValueEx" title="Permalink to this definition">¶</a></dt> <dd><p>Retrieves the type and data for a specified value name associated with an open registry key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>value_name</em> is a string indicating the value to query.</p> <p>The result is a tuple of 2 items:</p> <table border="1" class="docutils"> <colgroup> <col width="15%" /> <col width="85%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Index</th> <th class="head">Meaning</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">0</span></code></td> <td>The value of the registry item.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">1</span></code></td> <td>An integer giving the registry type for this value (see table in docs for <a class="reference internal" href="#_winreg.SetValueEx" title="_winreg.SetValueEx"><code class="xref py py-meth docutils literal notranslate"><span class="pre">SetValueEx()</span></code></a>)</td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="_winreg.SaveKey"> <code class="descclassname">_winreg.</code><code class="descname">SaveKey</code><span class="sig-paren">(</span><em>key</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.SaveKey" title="Permalink to this definition">¶</a></dt> <dd><p>Saves the specified key, and all its subkeys to the specified file.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>file_name</em> 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 <a class="reference internal" href="#_winreg.LoadKey" title="_winreg.LoadKey"><code class="xref py py-meth docutils literal notranslate"><span class="pre">LoadKey()</span></code></a> method.</p> <p>If <em>key</em> represents a key on a remote computer, the path described by <em>file_name</em> is relative to the remote computer. The caller of this method must possess the <code class="xref py py-const docutils literal notranslate"><span class="pre">SeBackupPrivilege</span></code> security privilege. Note that privileges are different than permissions – see the <a class="reference external" href="http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx">Conflicts Between User Rights and Permissions documentation</a> for more details.</p> <p>This function passes NULL for <em>security_attributes</em> to the API.</p> </dd></dl> <dl class="function"> <dt id="_winreg.SetValue"> <code class="descclassname">_winreg.</code><code class="descname">SetValue</code><span class="sig-paren">(</span><em>key</em>, <em>sub_key</em>, <em>type</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.SetValue" title="Permalink to this definition">¶</a></dt> <dd><p>Associates a value with a specified key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>sub_key</em> is a string that names the subkey with which the value is associated.</p> <p><em>type</em> is an integer that specifies the type of the data. Currently this must be <a class="reference internal" href="#_winreg.REG_SZ" title="_winreg.REG_SZ"><code class="xref py py-const docutils literal notranslate"><span class="pre">REG_SZ</span></code></a>, meaning only strings are supported. Use the <a class="reference internal" href="#_winreg.SetValueEx" title="_winreg.SetValueEx"><code class="xref py py-func docutils literal notranslate"><span class="pre">SetValueEx()</span></code></a> function for support for other data types.</p> <p><em>value</em> is a string that specifies the new value.</p> <p>If the key specified by the <em>sub_key</em> parameter does not exist, the SetValue function creates it.</p> <p>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.</p> <p>The key identified by the <em>key</em> parameter must have been opened with <a class="reference internal" href="#_winreg.KEY_SET_VALUE" title="_winreg.KEY_SET_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_SET_VALUE</span></code></a> access.</p> </dd></dl> <dl class="function"> <dt id="_winreg.SetValueEx"> <code class="descclassname">_winreg.</code><code class="descname">SetValueEx</code><span class="sig-paren">(</span><em>key</em>, <em>value_name</em>, <em>reserved</em>, <em>type</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.SetValueEx" title="Permalink to this definition">¶</a></dt> <dd><p>Stores data in the value field of an open registry key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p><em>value_name</em> is a string that names the subkey with which the value is associated.</p> <p><em>type</em> is an integer that specifies the type of the data. See <a class="reference internal" href="#value-types"><span class="std std-ref">Value Types</span></a> for the available types.</p> <p><em>reserved</em> can be anything – zero is always passed to the API.</p> <p><em>value</em> is a string that specifies the new value.</p> <p>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 <a class="reference internal" href="#_winreg.KEY_SET_VALUE" title="_winreg.KEY_SET_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_SET_VALUE</span></code></a> access.</p> <p>To open the key, use the <a class="reference internal" href="#_winreg.CreateKey" title="_winreg.CreateKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">CreateKey()</span></code></a> or <a class="reference internal" href="#_winreg.OpenKey" title="_winreg.OpenKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">OpenKey()</span></code></a> methods.</p> <p>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.</p> </dd></dl> <dl class="function"> <dt id="_winreg.DisableReflectionKey"> <code class="descclassname">_winreg.</code><code class="descname">DisableReflectionKey</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.DisableReflectionKey" title="Permalink to this definition">¶</a></dt> <dd><p>Disables registry reflection for 32-bit processes running on a 64-bit operating system.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p>Will generally raise <a class="reference internal" href="constants.html#NotImplemented" title="NotImplemented"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NotImplemented</span></code></a> if executed on a 32-bit operating system.</p> <p>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.</p> </dd></dl> <dl class="function"> <dt id="_winreg.EnableReflectionKey"> <code class="descclassname">_winreg.</code><code class="descname">EnableReflectionKey</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.EnableReflectionKey" title="Permalink to this definition">¶</a></dt> <dd><p>Restores registry reflection for the specified disabled key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p>Will generally raise <a class="reference internal" href="constants.html#NotImplemented" title="NotImplemented"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NotImplemented</span></code></a> if executed on a 32-bit operating system.</p> <p>Restoring reflection for a key does not affect reflection of any subkeys.</p> </dd></dl> <dl class="function"> <dt id="_winreg.QueryReflectionKey"> <code class="descclassname">_winreg.</code><code class="descname">QueryReflectionKey</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.QueryReflectionKey" title="Permalink to this definition">¶</a></dt> <dd><p>Determines the reflection state for the specified key.</p> <p><em>key</em> is an already open key, or one of the predefined <a class="reference internal" href="#hkey-constants"><span class="std std-ref">HKEY_* constants</span></a>.</p> <p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if reflection is disabled.</p> <p>Will generally raise <a class="reference internal" href="constants.html#NotImplemented" title="NotImplemented"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NotImplemented</span></code></a> if executed on a 32-bit operating system.</p> </dd></dl> <div class="section" id="constants"> <span id="id1"></span><h2>35.3.1. Constants<a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2> <p>The following constants are defined for use in many <a class="reference internal" href="#module-_winreg" title="_winreg: Routines and objects for manipulating the Windows registry. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">_winreg</span></code></a> functions.</p> <div class="section" id="hkey-constants"> <span id="id2"></span><h3>35.3.1.1. HKEY_* Constants<a class="headerlink" href="#hkey-constants" title="Permalink to this headline">¶</a></h3> <dl class="data"> <dt id="_winreg.HKEY_CLASSES_ROOT"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_CLASSES_ROOT</code><a class="headerlink" href="#_winreg.HKEY_CLASSES_ROOT" title="Permalink to this definition">¶</a></dt> <dd><p>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.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_CURRENT_USER"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_CURRENT_USER</code><a class="headerlink" href="#_winreg.HKEY_CURRENT_USER" title="Permalink to this definition">¶</a></dt> <dd><p>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.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_LOCAL_MACHINE"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_LOCAL_MACHINE</code><a class="headerlink" href="#_winreg.HKEY_LOCAL_MACHINE" title="Permalink to this definition">¶</a></dt> <dd><p>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.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_USERS"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_USERS</code><a class="headerlink" href="#_winreg.HKEY_USERS" title="Permalink to this definition">¶</a></dt> <dd><p>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.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_PERFORMANCE_DATA"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_PERFORMANCE_DATA</code><a class="headerlink" href="#_winreg.HKEY_PERFORMANCE_DATA" title="Permalink to this definition">¶</a></dt> <dd><p>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.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_CURRENT_CONFIG"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_CURRENT_CONFIG</code><a class="headerlink" href="#_winreg.HKEY_CURRENT_CONFIG" title="Permalink to this definition">¶</a></dt> <dd><p>Contains information about the current hardware profile of the local computer system.</p> </dd></dl> <dl class="data"> <dt id="_winreg.HKEY_DYN_DATA"> <code class="descclassname">_winreg.</code><code class="descname">HKEY_DYN_DATA</code><a class="headerlink" href="#_winreg.HKEY_DYN_DATA" title="Permalink to this definition">¶</a></dt> <dd><p>This key is not used in versions of Windows after 98.</p> </dd></dl> </div> <div class="section" id="access-rights"> <span id="id3"></span><h3>35.3.1.2. Access Rights<a class="headerlink" href="#access-rights" title="Permalink to this headline">¶</a></h3> <p>For more information, see <a class="reference external" href="http://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx">Registry Key Security and Access</a>.</p> <dl class="data"> <dt id="_winreg.KEY_ALL_ACCESS"> <code class="descclassname">_winreg.</code><code class="descname">KEY_ALL_ACCESS</code><a class="headerlink" href="#_winreg.KEY_ALL_ACCESS" title="Permalink to this definition">¶</a></dt> <dd><p>Combines the STANDARD_RIGHTS_REQUIRED, <a class="reference internal" href="#_winreg.KEY_QUERY_VALUE" title="_winreg.KEY_QUERY_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_QUERY_VALUE</span></code></a>, <a class="reference internal" href="#_winreg.KEY_SET_VALUE" title="_winreg.KEY_SET_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_SET_VALUE</span></code></a>, <a class="reference internal" href="#_winreg.KEY_CREATE_SUB_KEY" title="_winreg.KEY_CREATE_SUB_KEY"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_CREATE_SUB_KEY</span></code></a>, <a class="reference internal" href="#_winreg.KEY_ENUMERATE_SUB_KEYS" title="_winreg.KEY_ENUMERATE_SUB_KEYS"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_ENUMERATE_SUB_KEYS</span></code></a>, <a class="reference internal" href="#_winreg.KEY_NOTIFY" title="_winreg.KEY_NOTIFY"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_NOTIFY</span></code></a>, and <a class="reference internal" href="#_winreg.KEY_CREATE_LINK" title="_winreg.KEY_CREATE_LINK"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_CREATE_LINK</span></code></a> access rights.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_WRITE"> <code class="descclassname">_winreg.</code><code class="descname">KEY_WRITE</code><a class="headerlink" href="#_winreg.KEY_WRITE" title="Permalink to this definition">¶</a></dt> <dd><p>Combines the STANDARD_RIGHTS_WRITE, <a class="reference internal" href="#_winreg.KEY_SET_VALUE" title="_winreg.KEY_SET_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_SET_VALUE</span></code></a>, and <a class="reference internal" href="#_winreg.KEY_CREATE_SUB_KEY" title="_winreg.KEY_CREATE_SUB_KEY"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_CREATE_SUB_KEY</span></code></a> access rights.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_READ"> <code class="descclassname">_winreg.</code><code class="descname">KEY_READ</code><a class="headerlink" href="#_winreg.KEY_READ" title="Permalink to this definition">¶</a></dt> <dd><p>Combines the STANDARD_RIGHTS_READ, <a class="reference internal" href="#_winreg.KEY_QUERY_VALUE" title="_winreg.KEY_QUERY_VALUE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_QUERY_VALUE</span></code></a>, <a class="reference internal" href="#_winreg.KEY_ENUMERATE_SUB_KEYS" title="_winreg.KEY_ENUMERATE_SUB_KEYS"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_ENUMERATE_SUB_KEYS</span></code></a>, and <a class="reference internal" href="#_winreg.KEY_NOTIFY" title="_winreg.KEY_NOTIFY"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_NOTIFY</span></code></a> values.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_EXECUTE"> <code class="descclassname">_winreg.</code><code class="descname">KEY_EXECUTE</code><a class="headerlink" href="#_winreg.KEY_EXECUTE" title="Permalink to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#_winreg.KEY_READ" title="_winreg.KEY_READ"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_READ</span></code></a>.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_QUERY_VALUE"> <code class="descclassname">_winreg.</code><code class="descname">KEY_QUERY_VALUE</code><a class="headerlink" href="#_winreg.KEY_QUERY_VALUE" title="Permalink to this definition">¶</a></dt> <dd><p>Required to query the values of a registry key.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_SET_VALUE"> <code class="descclassname">_winreg.</code><code class="descname">KEY_SET_VALUE</code><a class="headerlink" href="#_winreg.KEY_SET_VALUE" title="Permalink to this definition">¶</a></dt> <dd><p>Required to create, delete, or set a registry value.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_CREATE_SUB_KEY"> <code class="descclassname">_winreg.</code><code class="descname">KEY_CREATE_SUB_KEY</code><a class="headerlink" href="#_winreg.KEY_CREATE_SUB_KEY" title="Permalink to this definition">¶</a></dt> <dd><p>Required to create a subkey of a registry key.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_ENUMERATE_SUB_KEYS"> <code class="descclassname">_winreg.</code><code class="descname">KEY_ENUMERATE_SUB_KEYS</code><a class="headerlink" href="#_winreg.KEY_ENUMERATE_SUB_KEYS" title="Permalink to this definition">¶</a></dt> <dd><p>Required to enumerate the subkeys of a registry key.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_NOTIFY"> <code class="descclassname">_winreg.</code><code class="descname">KEY_NOTIFY</code><a class="headerlink" href="#_winreg.KEY_NOTIFY" title="Permalink to this definition">¶</a></dt> <dd><p>Required to request change notifications for a registry key or for subkeys of a registry key.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_CREATE_LINK"> <code class="descclassname">_winreg.</code><code class="descname">KEY_CREATE_LINK</code><a class="headerlink" href="#_winreg.KEY_CREATE_LINK" title="Permalink to this definition">¶</a></dt> <dd><p>Reserved for system use.</p> </dd></dl> <div class="section" id="bit-specific"> <span id="bit-access-rights"></span><h4>35.3.1.2.1. 64-bit Specific<a class="headerlink" href="#bit-specific" title="Permalink to this headline">¶</a></h4> <p>For more information, see <a class="reference external" href="http://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx">Accessing an Alternate Registry View</a>.</p> <dl class="data"> <dt id="_winreg.KEY_WOW64_64KEY"> <code class="descclassname">_winreg.</code><code class="descname">KEY_WOW64_64KEY</code><a class="headerlink" href="#_winreg.KEY_WOW64_64KEY" title="Permalink to this definition">¶</a></dt> <dd><p>Indicates that an application on 64-bit Windows should operate on the 64-bit registry view.</p> </dd></dl> <dl class="data"> <dt id="_winreg.KEY_WOW64_32KEY"> <code class="descclassname">_winreg.</code><code class="descname">KEY_WOW64_32KEY</code><a class="headerlink" href="#_winreg.KEY_WOW64_32KEY" title="Permalink to this definition">¶</a></dt> <dd><p>Indicates that an application on 64-bit Windows should operate on the 32-bit registry view.</p> </dd></dl> </div> </div> <div class="section" id="value-types"> <span id="id4"></span><h3>35.3.1.3. Value Types<a class="headerlink" href="#value-types" title="Permalink to this headline">¶</a></h3> <p>For more information, see <a class="reference external" href="http://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx">Registry Value Types</a>.</p> <dl class="data"> <dt id="_winreg.REG_BINARY"> <code class="descclassname">_winreg.</code><code class="descname">REG_BINARY</code><a class="headerlink" href="#_winreg.REG_BINARY" title="Permalink to this definition">¶</a></dt> <dd><p>Binary data in any form.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_DWORD"> <code class="descclassname">_winreg.</code><code class="descname">REG_DWORD</code><a class="headerlink" href="#_winreg.REG_DWORD" title="Permalink to this definition">¶</a></dt> <dd><p>32-bit number.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_DWORD_LITTLE_ENDIAN"> <code class="descclassname">_winreg.</code><code class="descname">REG_DWORD_LITTLE_ENDIAN</code><a class="headerlink" href="#_winreg.REG_DWORD_LITTLE_ENDIAN" title="Permalink to this definition">¶</a></dt> <dd><p>A 32-bit number in little-endian format.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_DWORD_BIG_ENDIAN"> <code class="descclassname">_winreg.</code><code class="descname">REG_DWORD_BIG_ENDIAN</code><a class="headerlink" href="#_winreg.REG_DWORD_BIG_ENDIAN" title="Permalink to this definition">¶</a></dt> <dd><p>A 32-bit number in big-endian format.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_EXPAND_SZ"> <code class="descclassname">_winreg.</code><code class="descname">REG_EXPAND_SZ</code><a class="headerlink" href="#_winreg.REG_EXPAND_SZ" title="Permalink to this definition">¶</a></dt> <dd><p>Null-terminated string containing references to environment variables (<code class="docutils literal notranslate"><span class="pre">%PATH%</span></code>).</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_LINK"> <code class="descclassname">_winreg.</code><code class="descname">REG_LINK</code><a class="headerlink" href="#_winreg.REG_LINK" title="Permalink to this definition">¶</a></dt> <dd><p>A Unicode symbolic link.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_MULTI_SZ"> <code class="descclassname">_winreg.</code><code class="descname">REG_MULTI_SZ</code><a class="headerlink" href="#_winreg.REG_MULTI_SZ" title="Permalink to this definition">¶</a></dt> <dd><p>A sequence of null-terminated strings, terminated by two null characters. (Python handles this termination automatically.)</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_NONE"> <code class="descclassname">_winreg.</code><code class="descname">REG_NONE</code><a class="headerlink" href="#_winreg.REG_NONE" title="Permalink to this definition">¶</a></dt> <dd><p>No defined value type.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_RESOURCE_LIST"> <code class="descclassname">_winreg.</code><code class="descname">REG_RESOURCE_LIST</code><a class="headerlink" href="#_winreg.REG_RESOURCE_LIST" title="Permalink to this definition">¶</a></dt> <dd><p>A device-driver resource list.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_FULL_RESOURCE_DESCRIPTOR"> <code class="descclassname">_winreg.</code><code class="descname">REG_FULL_RESOURCE_DESCRIPTOR</code><a class="headerlink" href="#_winreg.REG_FULL_RESOURCE_DESCRIPTOR" title="Permalink to this definition">¶</a></dt> <dd><p>A hardware setting.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_RESOURCE_REQUIREMENTS_LIST"> <code class="descclassname">_winreg.</code><code class="descname">REG_RESOURCE_REQUIREMENTS_LIST</code><a class="headerlink" href="#_winreg.REG_RESOURCE_REQUIREMENTS_LIST" title="Permalink to this definition">¶</a></dt> <dd><p>A hardware resource list.</p> </dd></dl> <dl class="data"> <dt id="_winreg.REG_SZ"> <code class="descclassname">_winreg.</code><code class="descname">REG_SZ</code><a class="headerlink" href="#_winreg.REG_SZ" title="Permalink to this definition">¶</a></dt> <dd><p>A null-terminated string.</p> </dd></dl> </div> </div> <div class="section" id="registry-handle-objects"> <span id="handle-object"></span><h2>35.3.2. Registry Handle Objects<a class="headerlink" href="#registry-handle-objects" title="Permalink to this headline">¶</a></h2> <p>This object wraps a Windows HKEY object, automatically closing it when the object is destroyed. To guarantee cleanup, you can call either the <a class="reference internal" href="#_winreg.PyHKEY.Close" title="_winreg.PyHKEY.Close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Close()</span></code></a> method on the object, or the <a class="reference internal" href="#_winreg.CloseKey" title="_winreg.CloseKey"><code class="xref py py-func docutils literal notranslate"><span class="pre">CloseKey()</span></code></a> function.</p> <p>All registry functions in this module return one of these objects.</p> <p>All registry functions in this module which accept a handle object also accept an integer, however, use of the handle object is encouraged.</p> <p>Handle objects provide semantics for <a class="reference internal" href="../reference/datamodel.html#object.__nonzero__" title="object.__nonzero__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__nonzero__()</span></code></a> – thus:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">handle</span><span class="p">:</span> <span class="nb">print</span> <span class="s2">"Yes"</span> </pre></div> </div> <p>will print <code class="docutils literal notranslate"><span class="pre">Yes</span></code> if the handle is currently valid (has not been closed or detached).</p> <p>The object also support comparison semantics, so handle objects will compare true if they both reference the same underlying Windows handle value.</p> <p>Handle objects can be converted to an integer (e.g., using the built-in <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-func docutils literal notranslate"><span class="pre">int()</span></code></a> function), in which case the underlying Windows handle value is returned. You can also use the <a class="reference internal" href="#_winreg.PyHKEY.Detach" title="_winreg.PyHKEY.Detach"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Detach()</span></code></a> method to return the integer handle, and also disconnect the Windows handle from the handle object.</p> <dl class="method"> <dt id="_winreg.PyHKEY.Close"> <code class="descclassname">PyHKEY.</code><code class="descname">Close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.PyHKEY.Close" title="Permalink to this definition">¶</a></dt> <dd><p>Closes the underlying Windows handle.</p> <p>If the handle is already closed, no error is raised.</p> </dd></dl> <dl class="method"> <dt id="_winreg.PyHKEY.Detach"> <code class="descclassname">PyHKEY.</code><code class="descname">Detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.PyHKEY.Detach" title="Permalink to this definition">¶</a></dt> <dd><p>Detaches the Windows handle from the handle object.</p> <p>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.</p> <p>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.</p> </dd></dl> <dl class="method"> <dt id="_winreg.PyHKEY.__enter__"> <code class="descclassname">PyHKEY.</code><code class="descname">__enter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.PyHKEY.__enter__" title="Permalink to this definition">¶</a></dt> <dt id="_winreg.PyHKEY.__exit__"> <code class="descclassname">PyHKEY.</code><code class="descname">__exit__</code><span class="sig-paren">(</span><em>*exc_info</em><span class="sig-paren">)</span><a class="headerlink" href="#_winreg.PyHKEY.__exit__" title="Permalink to this definition">¶</a></dt> <dd><p>The HKEY object implements <a class="reference internal" href="../reference/datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__enter__()</span></code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__exit__()</span></code></a> and thus supports the context protocol for the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">OpenKey</span><span class="p">(</span><span class="n">HKEY_LOCAL_MACHINE</span><span class="p">,</span> <span class="s2">"foo"</span><span class="p">)</span> <span class="k">as</span> <span class="n">key</span><span class="p">:</span> <span class="o">...</span> <span class="c1"># work with key</span> </pre></div> </div> <p>will automatically close <em>key</em> when control leaves the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> block.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">35.3. <code class="docutils literal notranslate"><span class="pre">_winreg</span></code> — Windows registry access</a><ul> <li><a class="reference internal" href="#constants">35.3.1. Constants</a><ul> <li><a class="reference internal" href="#hkey-constants">35.3.1.1. HKEY_* Constants</a></li> <li><a class="reference internal" href="#access-rights">35.3.1.2. Access Rights</a><ul> <li><a class="reference internal" href="#bit-specific">35.3.1.2.1. 64-bit Specific</a></li> </ul> </li> <li><a class="reference internal" href="#value-types">35.3.1.3. Value Types</a></li> </ul> </li> <li><a class="reference internal" href="#registry-handle-objects">35.3.2. Registry Handle Objects</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="msvcrt.html" title="previous chapter">35.2. <code class="docutils literal notranslate"><span class="pre">msvcrt</span></code> — Useful routines from the MS VC++ runtime</a></p> <h4>Next topic</h4> <p class="topless"><a href="winsound.html" title="next chapter">35.4. <code class="docutils literal notranslate"><span class="pre">winsound</span></code> — Sound-playing interface for Windows</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/_winreg.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="winsound.html" title="35.4. winsound — Sound-playing interface for Windows" >next</a> |</li> <li class="right" > <a href="msvcrt.html" title="35.2. msvcrt — Useful routines from the MS VC++ runtime" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="windows.html" >35. MS Windows Specific Services</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Mar 27, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Save
cmd:
run