PageRenderTime 47ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 1ms

/python/c-api/objbuffer.html

https://bitbucket.org/stillzhl/manuals
HTML | 213 lines | 195 code | 18 blank | 0 comment | 0 complexity | 16e2d63592436f47554f35e796c420e4 MD5 | raw file
    

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    4. 

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    5. 

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">
    7. 

  7.   <head>
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     
    10. 

  10.     <title>Old Buffer Protocol &mdash; Python v2.7.3 documentation</title>
    11. 

  11.     <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    13. 

  13.     <script type="text/javascript">
    14. 

  14.       var DOCUMENTATION_OPTIONS = {
    15. 

  15.         URL_ROOT:    '../',
    16. 

  16.         VERSION:     '2.7.3',
    17. 

  17.         COLLAPSE_INDEX: false,
    18. 

  18.         FILE_SUFFIX: '.html',
    19. 

  19.         HAS_SOURCE:  true
    20. 

  20.       };
    21. 

  21.     </script>
    22. 

  22.     <script type="text/javascript" src="../_static/jquery.js"></script>
    23. 

  23.     <script type="text/javascript" src="../_static/underscore.js"></script>
    24. 

  24.     <script type="text/javascript" src="../_static/doctools.js"></script>
    25. 

  25.     <script type="text/javascript" src="../_static/sidebar.js"></script>
    26. 

  26.     <link rel="search" type="application/opensearchdescription+xml"
    27. 

  27.           title="Search within Python v2.7.3 documentation"
    28. 

  28.           href="../_static/opensearch.xml"/>
    29. 

  29.     <link rel="author" title="About these documents" href="../about.html" />
    30. 

  30.     <link rel="copyright" title="Copyright" href="../copyright.html" />
    31. 

  31.     <link rel="top" title="Python v2.7.3 documentation" href="../index.html" />
    32. 

  32.     <link rel="up" title="Abstract Objects Layer" href="abstract.html" />
    33. 

  33.     <link rel="next" title="Concrete Objects Layer" href="concrete.html" />
    34. 

  34.     <link rel="prev" title="Iterator Protocol" href="iter.html" />
    35. 

  35.     <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
    36. 

  36.     <script type="text/javascript" src="../_static/copybutton.js"></script>
    37. 

  37.     <script type="text/javascript" src="../_static/version_switch.js"></script>
    38. 

  38.  
    39. 

  39. 

  40.   </head>
    41. 

  41.   <body>
    42. 

  42.     <div class="related">
    43. 

  43.       <h3>Navigation</h3>
    44. 

  44.       <ul>
    45. 

  45.         <li class="right" style="margin-right: 10px">
    46. 

  46.           <a href="../genindex.html" title="General Index"
    47. 

  47.              accesskey="I">index</a></li>
    48. 

  48.         <li class="right" >
    49. 

  49.           <a href="../py-modindex.html" title="Python Module Index"
    50. 

  50.              >modules</a> |</li>
    51. 

  51.         <li class="right" >
    52. 

  52.           <a href="concrete.html" title="Concrete Objects Layer"
    53. 

  53.              accesskey="N">next</a> |</li>
    54. 

  54.         <li class="right" >
    55. 

  55.           <a href="iter.html" title="Iterator Protocol"
    56. 

  56.              accesskey="P">previous</a> |</li>
    57. 

  57.         <li><img src="../_static/py.png" alt=""
    58. 

  58.                  style="vertical-align: middle; margin-top: -1px"/></li>
    59. 

  59.         <li><a href="http://www.python.org/">Python</a> &raquo;</li>
    60. 

  60.         <li>
    61. 

  61.           <span class="version_switcher_placeholder">2.7.3</span>
    62. 

  62.           <a href="../index.html">Documentation</a> &raquo;
    63. 

  63.         </li>
    64. 

  64. 

  65.           <li><a href="index.html" >Python/C API Reference Manual</a> &raquo;</li>
    66. 

  66.           <li><a href="abstract.html" accesskey="U">Abstract Objects Layer</a> &raquo;</li> 
    67. 

  67.       </ul>
    68. 

  68.     </div>  
    69. 

  69. 

  70.     <div class="document">
    71. 

  71.       <div class="documentwrapper">
    72. 

  72.         <div class="bodywrapper">
    73. 

  73.           <div class="body">
    74. 

  74.             
    75. 

  75.   <div class="section" id="old-buffer-protocol">
    76. 

  76. <span id="abstract-buffer"></span><h1>Old Buffer Protocol<a class="headerlink" href="#old-buffer-protocol" title="Permalink to this headline"></a></h1>
    77. 

  77. <p>This section describes the legacy buffer protocol, which has been introduced
    78. 

  78. in Python 1.6. It is still supported but deprecated in the Python 2.x series.
    79. 

  79. Python 3 introduces a new buffer protocol which fixes weaknesses and
    80. 

  80. shortcomings of the protocol, and has been backported to Python 2.6.  See
    81. 

  81. <a class="reference internal" href="buffer.html#bufferobjects"><em>Buffers and Memoryview Objects</em></a> for more information.</p>
    82. 

  82. <dl class="function">
    83. 

  83. <dt id="PyObject_AsCharBuffer">
    84. 

  84. int <tt class="descname">PyObject_AsCharBuffer</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em>&nbsp;*obj</em>, const char<em>&nbsp;**buffer</em>, Py_ssize_t<em>&nbsp;*buffer_len</em><big>)</big><a class="headerlink" href="#PyObject_AsCharBuffer" title="Permalink to this definition"></a></dt>
    85. 

  85. <dd><p>Returns a pointer to a read-only memory location usable as character-based
    86. 

  86. input.  The <em>obj</em> argument must support the single-segment character buffer
    87. 

  87. interface.  On success, returns <tt class="docutils literal"><span class="pre">0</span></tt>, sets <em>buffer</em> to the memory location
    88. 

  88. and <em>buffer_len</em> to the buffer length.  Returns <tt class="docutils literal"><span class="pre">-1</span></tt> and sets a
    89. 

  89. <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> on error.</p>
    90. 

  90. <p class="versionadded">
    91. 

  91. <span class="versionmodified">New in version 1.6.</span></p>
    92. 

  92. <p class="versionchanged">
    93. 

  93. <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span> <span class="pre">*</span></tt> type for <em>buffer_len</em>. This might
    94. 

  94. require changes in your code for properly supporting 64-bit systems.</p>
    95. 

  95. </dd></dl>
    96. 

  96. 

  97. <dl class="function">
    98. 

  98. <dt id="PyObject_AsReadBuffer">
    99. 

  99. int <tt class="descname">PyObject_AsReadBuffer</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em>&nbsp;*obj</em>, const void<em>&nbsp;**buffer</em>, Py_ssize_t<em>&nbsp;*buffer_len</em><big>)</big><a class="headerlink" href="#PyObject_AsReadBuffer" title="Permalink to this definition"></a></dt>
    100. 

  100. <dd><p>Returns a pointer to a read-only memory location containing arbitrary data.
    101. 

  101. The <em>obj</em> argument must support the single-segment readable buffer
    102. 

  102. interface.  On success, returns <tt class="docutils literal"><span class="pre">0</span></tt>, sets <em>buffer</em> to the memory location
    103. 

  103. and <em>buffer_len</em> to the buffer length.  Returns <tt class="docutils literal"><span class="pre">-1</span></tt> and sets a
    104. 

  104. <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> on error.</p>
    105. 

  105. <p class="versionadded">
    106. 

  106. <span class="versionmodified">New in version 1.6.</span></p>
    107. 

  107. <p class="versionchanged">
    108. 

  108. <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span> <span class="pre">*</span></tt> type for <em>buffer_len</em>. This might
    109. 

  109. require changes in your code for properly supporting 64-bit systems.</p>
    110. 

  110. </dd></dl>
    111. 

  111. 

  112. <dl class="function">
    113. 

  113. <dt id="PyObject_CheckReadBuffer">
    114. 

  114. int <tt class="descname">PyObject_CheckReadBuffer</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em>&nbsp;*o</em><big>)</big><a class="headerlink" href="#PyObject_CheckReadBuffer" title="Permalink to this definition"></a></dt>
    115. 

  115. <dd><p>Returns <tt class="docutils literal"><span class="pre">1</span></tt> if <em>o</em> supports the single-segment readable buffer interface.
    116. 

  116. Otherwise returns <tt class="docutils literal"><span class="pre">0</span></tt>.</p>
    117. 

  117. <p class="versionadded">
    118. 

  118. <span class="versionmodified">New in version 2.2.</span></p>
    119. 

  119. </dd></dl>
    120. 

  120. 

  121. <dl class="function">
    122. 

  122. <dt id="PyObject_AsWriteBuffer">
    123. 

  123. int <tt class="descname">PyObject_AsWriteBuffer</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em>&nbsp;*obj</em>, void<em>&nbsp;**buffer</em>, Py_ssize_t<em>&nbsp;*buffer_len</em><big>)</big><a class="headerlink" href="#PyObject_AsWriteBuffer" title="Permalink to this definition"></a></dt>
    124. 

  124. <dd><p>Returns a pointer to a writeable memory location.  The <em>obj</em> argument must
    125. 

  125. support the single-segment, character buffer interface.  On success,
    126. 

  126. returns <tt class="docutils literal"><span class="pre">0</span></tt>, sets <em>buffer</em> to the memory location and <em>buffer_len</em> to the
    127. 

  127. buffer length.  Returns <tt class="docutils literal"><span class="pre">-1</span></tt> and sets a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> on error.</p>
    128. 

  128. <p class="versionadded">
    129. 

  129. <span class="versionmodified">New in version 1.6.</span></p>
    130. 

  130. <p class="versionchanged">
    131. 

  131. <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span> <span class="pre">*</span></tt> type for <em>buffer_len</em>. This might
    132. 

  132. require changes in your code for properly supporting 64-bit systems.</p>
    133. 

  133. </dd></dl>
    134. 

  134. 

  135. </div>
    136. 

  136. 

  137. 

  138.           </div>
    139. 

  139.         </div>
    140. 

  140.       </div>
    141. 

  141.       <div class="sphinxsidebar">
    142. 

  142.         <div class="sphinxsidebarwrapper">
    143. 

  143.   <h4>Previous topic</h4>
    144. 

  144.   <p class="topless"><a href="iter.html"
    145. 

  145.                         title="previous chapter">Iterator Protocol</a></p>
    146. 

  146.   <h4>Next topic</h4>
    147. 

  147.   <p class="topless"><a href="concrete.html"
    148. 

  148.                         title="next chapter">Concrete Objects Layer</a></p>
    149. 

  149. <h3>This Page</h3>
    150. 

  150. <ul class="this-page-menu">
    151. 

  151.   <li><a href="../bugs.html">Report a Bug</a></li>
    152. 

  152.   <li><a href="../_sources/c-api/objbuffer.txt"
    153. 

  153.          rel="nofollow">Show Source</a></li>
    154. 

  154. </ul>
    155. 

  155. 

  156. <div id="searchbox" style="display: none">
    157. 

  157.   <h3>Quick search</h3>
    158. 

  158.     <form class="search" action="../search.html" method="get">
    159. 

  159.       <input type="text" name="q" size="18" />
    160. 

  160.       <input type="submit" value="Go" />
    161. 

  161.       <input type="hidden" name="check_keywords" value="yes" />
    162. 

  162.       <input type="hidden" name="area" value="default" />
    163. 

  163.     </form>
    164. 

  164.     <p class="searchtip" style="font-size: 90%">
    165. 

  165.     Enter search terms or a module, class or function name.
    166. 

  166.     </p>
    167. 

  167. </div>
    168. 

  168. <script type="text/javascript">$('#searchbox').show(0);</script>
    169. 

  169.         </div>
    170. 

  170.       </div>
    171. 

  171.       <div class="clearer"></div>
    172. 

  172.     </div>
    173. 

  173.     <div class="related">
    174. 

  174.       <h3>Navigation</h3>
    175. 

  175.       <ul>
    176. 

  176.         <li class="right" style="margin-right: 10px">
    177. 

  177.           <a href="../genindex.html" title="General Index"
    178. 

  178.              >index</a></li>
    179. 

  179.         <li class="right" >
    180. 

  180.           <a href="../py-modindex.html" title="Python Module Index"
    181. 

  181.              >modules</a> |</li>
    182. 

  182.         <li class="right" >
    183. 

  183.           <a href="concrete.html" title="Concrete Objects Layer"
    184. 

  184.              >next</a> |</li>
    185. 

  185.         <li class="right" >
    186. 

  186.           <a href="iter.html" title="Iterator Protocol"
    187. 

  187.              >previous</a> |</li>
    188. 

  188.         <li><img src="../_static/py.png" alt=""
    189. 

  189.                  style="vertical-align: middle; margin-top: -1px"/></li>
    190. 

  190.         <li><a href="http://www.python.org/">Python</a> &raquo;</li>
    191. 

  191.         <li>
    192. 

  192.           <span class="version_switcher_placeholder">2.7.3</span>
    193. 

  193.           <a href="../index.html">Documentation</a> &raquo;
    194. 

  194.         </li>
    195. 

  195. 

  196.           <li><a href="index.html" >Python/C API Reference Manual</a> &raquo;</li>
    197. 

  197.           <li><a href="abstract.html" >Abstract Objects Layer</a> &raquo;</li> 
    198. 

  198.       </ul>
    199. 

  199.     </div>
    200. 

  200.     <div class="footer">
    201. 

  201.     &copy; <a href="../copyright.html">Copyright</a> 1990-2013, Python Software Foundation.
    202. 

  202.     <br />
    203. 

  203.     The Python Software Foundation is a non-profit corporation.
    204. 

  204.     <a href="http://www.python.org/psf/donations/">Please donate.</a>
    205. 

  205.     <br />
    206. 

  206.     Last updated on Mar 20, 2013.
    207. 

  207.     <a href="../bugs.html">Found a bug</a>?
    208. 

  208.     <br />
    209. 

  209.     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    210. 

  210.     </div>
    211. 

  211. 

  212.   </body>
    213. 

  213. </html>
    214.