Old Buffer Protocol¶

This section describes the legacy buffer protocol, which has been introducedin Python 1.6. It is still supported but deprecated in the Python 2.x series.Python 3 introduces a new buffer protocol which fixes weaknesses andshortcomings of the protocol, and has been backported to Python 2.6. SeeBuffers and Memoryview Objects for more information.

intPyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len)¶

Returns a pointer to a read-only memory location usable as character-basedinput. Theobj argument must support the single-segment character bufferinterface. On success, returns0, setsbuffer to the memory locationandbuffer_len to the buffer length. Returns-1 and sets aTypeError on error.

New in version 1.6.

Changed in version 2.5:This function used anint* type forbuffer_len. This mightrequire changes in your code for properly supporting 64-bit systems.

intPyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len)¶

Returns a pointer to a read-only memory location containing arbitrary data.Theobj argument must support the single-segment readable bufferinterface. On success, returns0, setsbuffer to the memory locationandbuffer_len to the buffer length. Returns-1 and sets aTypeError on error.

New in version 1.6.

Changed in version 2.5:This function used anint* type forbuffer_len. This mightrequire changes in your code for properly supporting 64-bit systems.

intPyObject_CheckReadBuffer(PyObject *o)¶

Returns1 ifo supports the single-segment readable buffer interface.Otherwise returns0.

New in version 2.2.

intPyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len)¶

Returns a pointer to a writeable memory location. Theobj argument mustsupport the single-segment, character buffer interface. On success,returns0, setsbuffer to the memory location andbuffer_len to thebuffer length. Returns-1 and sets aTypeError on error.

New in version 1.6.

Changed in version 2.5:This function used anint* type forbuffer_len. This mightrequire changes in your code for properly supporting 64-bit systems.