Commit 57aeba18 authored by Fred Drake's avatar Fred Drake

Use small tables instead of bare \item markers to describe the contents

of return tuples.  The bare \item took advantage of an implementation
detail when formatting in LaTeX, and was just wrong when generating HTML.
It also broke the XML conversion scripts, since there was no enclosing
list-like environment to contain them.
parent 41f52372
...@@ -126,13 +126,13 @@ This module offers the following functions: ...@@ -126,13 +126,13 @@ This module offers the following functions:
no more values. no more values.
The result is a tuple of 3 items: The result is a tuple of 3 items:
\item[value_name]
A string that identifies the value name \begin{tableii}{c|p{3in}}{code}{Index}{Meaning}
\item[value_data] \lineii{0}{A string that identifies the value name}
An object that holds the value data, and whose type depends \lineii{1}{An object that holds the value data, and whose
on the underlying registry type. type depends on the underlying registry type}
\item[data_type] is an integer that identifies the type of the \lineii{2}{An integer that identifies the type of the value data}
value data. \end{tableii}
\end{funcdesc} \end{funcdesc}
...@@ -218,13 +218,13 @@ This module offers the following functions: ...@@ -218,13 +218,13 @@ This module offers the following functions:
\constant{HKEY_*} constants. \constant{HKEY_*} constants.
The result is a tuple of 3 items: The result is a tuple of 3 items:
\item[num_subkeys]
An integer that identifies the number of sub keys this key has. \begin{tableii}{c|p{3in}}{code}{Index}{Meaning}
\item[num_values] \lineii{0}{An integer giving the number of sub keys this key has.}
An integer that identifies the number of values this key has. \lineii{1}{An integer giving the number of values this key has.}
\item [last_modified] \lineii{2}{A long integer giving when the key was last modified (if
A long integer that identifies when the key was last modified (if available) available) as 100's of nanoseconds since Jan 1, 1600.}
as 100's of nanoseconds since Jan 1, 1600. \end{tableii}
\end{funcdesc} \end{funcdesc}
...@@ -256,10 +256,11 @@ This module offers the following functions: ...@@ -256,10 +256,11 @@ This module offers the following functions:
\var{value_name} is a string indicating the value to query. \var{value_name} is a string indicating the value to query.
The result is a tuple of 2 items: The result is a tuple of 2 items:
\item [value]
The value of the registry item. \begin{tableii}{c|p{3in}}{code}{Index}{Meaning}
\item [type_id] \lineii{0}{The value of the registry item.}
An integer that identifies the registry type for this value. \lineii{1}{An integer giving the registry type for this value.}
\end{tableii}
\end{funcdesc} \end{funcdesc}
...@@ -294,9 +295,10 @@ This module offers the following functions: ...@@ -294,9 +295,10 @@ This module offers the following functions:
\var{sub_key} is a string that names the subkey with which the value \var{sub_key} is a string that names the subkey with which the value
is associated. is associated.
\var{type} is an integer that specifies the type of the data. Currently this \var{type} is an integer that specifies the type of the data.
must be \constant{REG_SZ}, meaning only strings are supported. Currently this must be \constant{REG_SZ}, meaning only strings are
Use the \function{SetValueEx()} function for support for other data types. supported. Use the \function{SetValueEx()} function for support for
other data types.
\var{value} is a string that specifies the new value. \var{value} is a string that specifies the new value.
...@@ -305,7 +307,8 @@ This module offers the following functions: ...@@ -305,7 +307,8 @@ This module offers the following functions:
Value lengths are limited by available memory. Long values (more than Value lengths are limited by available memory. Long values (more than
2048 bytes) should be stored as files with the filenames stored in 2048 bytes) should be stored as files with the filenames stored in
the configuration registry. This helps the registry perform efficiently. the configuration registry. This helps the registry perform
efficiently.
The key identified by the \var{key} parameter must have been The key identified by the \var{key} parameter must have been
opened with \constant{KEY_SET_VALUE} access. opened with \constant{KEY_SET_VALUE} access.
...@@ -322,30 +325,23 @@ This module offers the following functions: ...@@ -322,30 +325,23 @@ This module offers the following functions:
value is associated. value is associated.
\var{type} is an integer that specifies the type of the data. \var{type} is an integer that specifies the type of the data.
This should be one of: This should be one of the following constants defined in this module:
\item[\constant{REG_BINARY}]
Binary data in any form. \begin{tableii}{l|p{3in}}{constant}{Constant}{Meaning}
\item[\constant{REG_DWORD}] \lineii{REG_BINARY}{Binary data in any form.}
A 32-bit number. \lineii{REG_DWORD}{A 32-bit number.}
\item[\constant{REG_DWORD_LITTLE_ENDIAN}] \lineii{REG_DWORD_LITTLE_ENDIAN}{A 32-bit number in little-endian format.}
A 32-bit number in little-endian format. \lineii{REG_DWORD_BIG_ENDIAN}{A 32-bit number in big-endian format.}
\item[\constant{REG_DWORD_BIG_ENDIAN}] \lineii{REG_EXPAND_SZ}{Null-terminated string containing references
A 32-bit number in big-endian format. to environment variables (\samp{\%PATH\%}).}
\item[\constant{REG_EXPAND_SZ}] \lineii{REG_LINK}{A Unicode symbolic link.}
A null-terminated string that contains unexpanded references \lineii{REG_MULTI_SZ}{A sequence of null-terminated strings,
to environment variables (for example, \code{\%PATH\%}) terminated by two null characters. (Python handles
\item[\constant{REG_LINK}] this termination automatically.)}
A Unicode symbolic link. \lineii{REG_NONE}{No defined value type.}
\item[\constant{REG_MULTI_SZ}] \lineii{REG_RESOURCE_LIST}{A device-driver resource list.}
A sequence (eg, list, sequence) of null-terminated strings, \lineii{REG_SZ}{A null-terminated string.}
terminated by two null characters. (Note that Python handles \end{tableii}
this termination automatically)
\item[\constant{REG_NONE}]
No defined value type.
\item[\constant{REG_RESOURCE_LIST}]
A device-driver resource list.
\item[\constant{REG_SZ}]
A null-terminated string.
\var{reserved} can be anything - zero is always passed to the \var{reserved} can be anything - zero is always passed to the
API. API.
...@@ -366,7 +362,7 @@ This module offers the following functions: ...@@ -366,7 +362,7 @@ This module offers the following functions:
\subsection{Registry handle objects \label{handle-object}} \subsection{Registry Handle Objects \label{handle-object}}
This object wraps a Windows HKEY object, automatically closing it when This object wraps a Windows HKEY object, automatically closing it when
the object is destroyed. To guarantee cleanup, you can call either the object is destroyed. To guarantee cleanup, you can call either
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment