languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-07-21 18:25:47 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

SF bug #670229: doc improvement for cStringIO.h

Browse source 
Gernot Hillier added more detail to the internal API documentation.
This commit is contained in:
Raymond Hettinger 2003-01-19 00:45:01 +00:00
parent 9543b34006
commit 7b8e281997
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
Include/cStringIO.h
View file

@ -26,22 +26,29 @@ extern "C" {
static struct PycStringIO_CAPI {
/* Read a string. If the last argument is -1, the remainder will be read. */
/* Read a string from an input object. If the last argument
is -1, the remainder will be read.
*/
int(*cread)(PyObject *, char **, int);
/* Read a line */
/* Read a line from an input object. Returns the length of the read
line as an int and a pointer inside the object buffer as char** (so
the caller doesn't have to provide its own buffer as destination).
*/
int(*creadline)(PyObject *, char **);
/* Write a string */
/* Write a string to an output object*/
int(*cwrite)(PyObject *, char *, int);
/* Get the cStringIO object as a Python string */
/* Get the output object as a Python string (returns new reference). */
PyObject *(*cgetvalue)(PyObject *);
/* Create a new output object */
PyObject *(*NewOutput)(int);
/* Create an input object from a Python string */
/* Create an input object from a Python string
(copies the Python string reference).
*/
PyObject *(*NewInput)(PyObject *);
/* The Python types for cStringIO input and output objects.