From: Fred Drake <fdrake@acm.org>
Date: Thu, 4 Apr 2002 04:21:23 +0000 (+0000)
Subject: Add the PyObject_As*Buffer() functions that apply, now that the docs have been
X-Git-Tag: v2.1.3~25
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5c7855afb9abdbc8aaafe3c27e4665dec7f61ef9;p=thirdparty%2FPython%2Fcpython.git

Add the PyObject_As*Buffer() functions that apply, now that the docs have been
corrected and I'm dealing with them anyway.
---

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 62e2eafd0d30..c0173c7c65d4 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -2117,6 +2117,43 @@ statement \samp{\var{o}[\var{key}] = \var{v}}.
 \end{cfuncdesc}
 
 
+\section{Buffer Protocol \label{abstract-buffer}}
+
+\begin{cfuncdesc}{int}{PyObject_AsCharBuffer}{PyObject *obj,
+                                              const char **buffer,
+                                              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{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}
+
+\begin{cfuncdesc}{int}{PyObject_AsReadBuffer}{PyObject *obj,
+                                              const char **buffer,
+                                              int *buffer_len}
+  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{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}
+
+\begin{cfuncdesc}{int}{PyObject_AsWriteBuffer}{PyObject *obj,
+                                               const char **buffer,
+                                               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{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}
+
+
 \chapter{Concrete Objects Layer \label{concrete}}
 
 The functions in this chapter are specific to certain Python object