<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"api.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"api.html" title='Python/C API Reference Manual'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"prev" href=
"iterator.html" />
<link rel=
"parent" href=
"abstract.html" />
<link rel=
"next" href=
"concrete.html" />
<meta name='aesop' content='information'
/>
<title>6.6 Buffer Protocol
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"6.5 Iterator Protocol"
href=
"iterator.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"6. Abstract Objects Layer"
href=
"abstract.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7. Concrete Objects Layer"
href=
"concrete.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"iterator.html">6.5 Iterator Protocol
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"abstract.html">6. Abstract Objects Layer
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"concrete.html">7. Concrete Objects Layer
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION008600000000000000000"></A><A NAME=
"abstract-buffer"></A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
348' xml:id='l2h-
348'
class=
"cfunction">PyObject_AsCharBuffer
</tt></b>(
</nobr></td><td>PyObject *
<var>obj
</var>,
const char **
<var>buffer
</var>,
int *
<var>buffer_len
</var>)
</td></tr></table></dt>
Returns a pointer to a read-only memory location useable as character-
based input. The
<var>obj
</var> argument must support the single-segment
character buffer interface. On success, returns
<code>0</code>, sets
<var>buffer
</var> to the memory location and
<var>buffer_len
</var> to the buffer
length. Returns
<code>-
1</code> and sets a
<tt class=
"exception">TypeError
</tt> on error.
<span class=
"versionnote">New in version
1.6.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
349' xml:id='l2h-
349'
class=
"cfunction">PyObject_AsReadBuffer
</tt></b>(
</nobr></td><td>PyObject *
<var>obj
</var>,
const void **
<var>buffer
</var>,
int *
<var>buffer_len
</var>)
</td></tr></table></dt>
Returns a pointer to a read-only memory location containing
arbitrary data. The
<var>obj
</var> argument must support the
single-segment readable buffer interface. On success, returns
<code>0</code>, sets
<var>buffer
</var> to the memory location and
<var>buffer_len
</var>
to the buffer length. Returns
<code>-
1</code> and sets a
<tt class=
"exception">TypeError
</tt> on error.
<span class=
"versionnote">New in version
1.6.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
350' xml:id='l2h-
350'
class=
"cfunction">PyObject_CheckReadBuffer
</tt></b>(
</nobr></td><td>PyObject *
<var>o
</var>)
</td></tr></table></dt>
Returns
<code>1</code> if
<var>o
</var> supports the single-segment readable
buffer interface. Otherwise returns
<code>0</code>.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
351' xml:id='l2h-
351'
class=
"cfunction">PyObject_AsWriteBuffer
</tt></b>(
</nobr></td><td>PyObject *
<var>obj
</var>,
void **
<var>buffer
</var>,
int *
<var>buffer_len
</var>)
</td></tr></table></dt>
Returns a pointer to a writeable memory location. The
<var>obj
</var>
argument must support the single-segment, character buffer
interface. On success, returns
<code>0</code>, sets
<var>buffer
</var> to the
memory location and
<var>buffer_len
</var> to the buffer length. Returns
<code>-
1</code> and sets a
<tt class=
"exception">TypeError
</tt> on error.
<span class=
"versionnote">New in version
1.6.
</span>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"6.5 Iterator Protocol"
href=
"iterator.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"6. Abstract Objects Layer"
href=
"abstract.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7. Concrete Objects Layer"
href=
"concrete.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"iterator.html">6.5 Iterator Protocol
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"abstract.html">6. Abstract Objects Layer
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"concrete.html">7. Concrete Objects Layer
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.