mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-02 06:14:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added version annotations, remove hard tabs.

Browse Source
This commit is contained in:
Fred Drake 2001-11-09 23:34:26 +00:00
parent 9f64caaf00
commit 94ead57dc3
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/api/abstract.tex
View File

@ -868,42 +868,46 @@ else {
/* continue doing useful work */
}
\section{Buffer Protocol \label{buffer}}
\section{Buffer Protocol \label{abstract-buffer}}
\begin{cfuncdesc}{int}{PyObject_AsCharBuffer}{PyObject *obj,
const char **buffer,
int *buffer_len}
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{1}, sets
\var{buffer} to the memory location and \var{buffer} to the buffer
length. Returns \code{0} 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}
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{1}, sets \var{buffer} to the memory location and \var{buffer}
to the buffer length. Returns \code{0} and sets a
\exception{TypeError} on error.
\versionadded{1.6}
\end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_CheckReadBuffer}{PyObject *o}
Returns \code{1} if \var{o} supports the single-segment readable
buffer interface. Otherwise returns \code{0}.
\versionadded{2.2}
\enc{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_AsWriteBuffer}{PyObject *obj,
const char **buffer,
int *buffer_len}
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{1}, sets \var{buffer} to the
memory location and \var{buffer} to the buffer length. Returns
\code{0} and sets a \exception{TypeError} on error.
\versionadded{1.6}
\end{cfuncdesc}
\end{verbatim}