summaryrefslogtreecommitdiffstats
path: root/Doc/api/abstract.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-04-04 04:10:36 (GMT)
committerFred Drake <fdrake@acm.org>2002-04-04 04:10:36 (GMT)
commit243ea7166913a6cf9852373b2a3d965d6587477b (patch)
treee1175188eb5f8848f0418d4056af30dab99c4cde /Doc/api/abstract.tex
parent645a22e007a7e5b6da110cc5c5696d336b4c41c6 (diff)
downloadcpython-243ea7166913a6cf9852373b2a3d965d6587477b.zip
cpython-243ea7166913a6cf9852373b2a3d965d6587477b.tar.gz
cpython-243ea7166913a6cf9852373b2a3d965d6587477b.tar.bz2
Correct the descriptions of the PyObject_As*Buffer() return values.
This closes SF bug #539081.
Diffstat (limited to 'Doc/api/abstract.tex')
-rw-r--r--Doc/api/abstract.tex12
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index 4d92268..07d6592 100644
--- a/Doc/api/abstract.tex
+++ b/Doc/api/abstract.tex
@@ -895,9 +895,9 @@ else {
int *buffer_len}
Returns a pointer to a read-only memory location useable as character-
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
- 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}
\end{cfuncdesc}
@@ -907,8 +907,8 @@ else {
Returns a pointer to a read-only memory location containing
arbitrary data. The \var{obj} argument must support the
single-segment readable buffer interface. On success, returns
- \code{1}, sets \var{buffer} to the memory location and \var{buffer_len}
- to the buffer length. Returns \code{0} and sets a
+ \code{0}, sets \var{buffer} to the memory location and \var{buffer_len}
+ to the buffer length. Returns \code{-1} and sets a
\exception{TypeError} on error.
\versionadded{1.6}
\end{cfuncdesc}
@@ -924,8 +924,8 @@ else {
int *buffer_len}
Returns a pointer to a writeable memory location. The \var{obj}
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
- \code{0} and sets a \exception{TypeError} on error.
+ \code{-1} and sets a \exception{TypeError} on error.
\versionadded{1.6}
\end{cfuncdesc}