traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Correct typo in description of the machine name parameter to the 

ConnectRegistry() function; there is no trailing period!
This commit is contained in:
Fred Drake 2000-07-06 04:38:37 +00:00
parent 63099f911f
commit d14423abe2
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Doc/lib/libwinreg.tex
View File

@ -8,17 +8,17 @@
\versionadded{2.0} \versionadded{2.0}
These functions exposes the Windows registry API to Python. Instead of These functions expose the Windows registry API to Python. Instead of
using an integer as the registry handle, a handle object is used to ensure using an integer as the registry handle, a handle object is used to
that the handles are closed correctly, even if the programmer ensure that the handles are closed correctly, even if the programmer
neglects to explicitly close them. neglects to explicitly close them.
This module exposes a very low-level interface to the Windows This module exposes a very low-level interface to the Windows
registry; for a more object-oriented interface, use the registry; for a more object-oriented interface, use the
\module{winreg} module. \module{winreg} module.
This module offers the following functions:
\subsection{Registry Operations \label{registry-operations}}
\begin{funcdesc}{CloseKey}{hkey} \begin{funcdesc}{CloseKey}{hkey}
Closes a previously opened registry key. Closes a previously opened registry key.
@ -35,8 +35,8 @@ registry; for a more object-oriented interface, use the
another computer, and returns a \dfn{handle object} another computer, and returns a \dfn{handle object}
\var{computer_name} is the name of the remote computer, of the \var{computer_name} is the name of the remote computer, of the
form \code{'\\\\computername.'}. If \code{None}, the local computer is form \samp{\e\e computername}. If \code{None}, the local computer
used. is used.
\var{key} is the predefined handle to connect to. \var{key} is the predefined handle to connect to.
@ -66,7 +66,6 @@ registry; for a more object-oriented interface, use the
raised. raised.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{DeleteKey}{key, sub_key} \begin{funcdesc}{DeleteKey}{key, sub_key}
Deletes the specified key. Deletes the specified key.
@ -372,21 +371,21 @@ registry; for a more object-oriented interface, use the
the object is destroyed. To guarantee cleanup, you can call either the object is destroyed. To guarantee cleanup, you can call either
the \method{Close()} method on the object, or the the \method{Close()} method on the object, or the
\function{CloseKey()} function. \function{CloseKey()} function.
All registry functions in this module return one of these objects. All registry functions in this module return one of these objects.
All registry functions in this module which accept a handle object All registry functions in this module which accept a handle object
also accept an integer, however, use of the handle object is also accept an integer, however, use of the handle object is
encouraged. encouraged.
Handle objects provide semantics for __nonzero__ - thus Handle objects provide semantics for \method{__nonzero__()} - thus
\begin{verbatim} \begin{verbatim}
if handle: if handle:
print "Yes" print "Yes"
\end{verbatim} \end{verbatim}
will print \code{Yes} if the handle is currently valid (ie, will print \code{Yes} if the handle is currently valid (i.e.,
has not been closed or detached). has not been closed or detached).
The object also support comparison semantics, so handle The object also support comparison semantics, so handle
objects will compare true if they both reference the same objects will compare true if they both reference the same
underlying Windows handle value. underlying Windows handle value.
@ -397,14 +396,14 @@ registry; for a more object-oriented interface, use the
\method{Detach()} method to return the integer handle, and \method{Detach()} method to return the integer handle, and
also disconnect the Windows handle from the handle object. also disconnect the Windows handle from the handle object.
\begin{methoddesc}{Close} \begin{methoddesc}{Close}{}
Closes the underlying Windows handle. Closes the underlying Windows handle.
If the handle is already closed, no error is raised. If the handle is already closed, no error is raised.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{Detach} \begin{methoddesc}{Detach}{}
Detaches the Windows handle from the handle object. Detaches the Windows handle from the handle object.
The result is an integer (or long on 64 bit Windows) that holds The result is an integer (or long on 64 bit Windows) that holds