Commit 243ea716 authored by Fred Drake's avatar Fred Drake

Correct the descriptions of the PyObject_As*Buffer() return values.

This closes SF bug #539081.
parent 645a22e0
...@@ -895,9 +895,9 @@ else { ...@@ -895,9 +895,9 @@ else {
int *buffer_len} int *buffer_len}
Returns a pointer to a read-only memory location useable as character- Returns a pointer to a read-only memory location useable as character-
based input. The \var{obj} argument must support the single-segment based input. The \var{obj} argument must support the single-segment
character buffer interface. On success, returns \code{1}, sets character buffer interface. On success, returns \code{0}, sets
\var{buffer} to the memory location and \var{buffer_len} to the buffer \var{buffer} to the memory location and \var{buffer_len} to the buffer
length. Returns \code{0} and sets a \exception{TypeError} on error. length. Returns \code{-1} and sets a \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}
...@@ -907,8 +907,8 @@ else { ...@@ -907,8 +907,8 @@ else {
Returns a pointer to a read-only memory location containing Returns a pointer to a read-only memory location containing
arbitrary data. The \var{obj} argument must support the arbitrary data. The \var{obj} argument must support the
single-segment readable buffer interface. On success, returns single-segment readable buffer interface. On success, returns
\code{1}, sets \var{buffer} to the memory location and \var{buffer_len} \code{0}, sets \var{buffer} to the memory location and \var{buffer_len}
to the buffer length. Returns \code{0} and sets a to the buffer length. Returns \code{-1} and sets a
\exception{TypeError} on error. \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}
...@@ -924,8 +924,8 @@ else { ...@@ -924,8 +924,8 @@ else {
int *buffer_len} int *buffer_len}
Returns a pointer to a writeable memory location. The \var{obj} Returns a pointer to a writeable memory location. The \var{obj}
argument must support the single-segment, character buffer argument must support the single-segment, character buffer
interface. On success, returns \code{1}, sets \var{buffer} to the interface. On success, returns \code{0}, sets \var{buffer} to the
memory location and \var{buffer_len} to the buffer length. Returns memory location and \var{buffer_len} to the buffer length. Returns
\code{0} and sets a \exception{TypeError} on error. \code{-1} and sets a \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}
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