Enhanced memory-reference information in the description of Py_BuildValue(),

based on response from Frank Stajano <fstajano@uk.research.att.com>.
This commit is contained in:
Fred Drake 2000-06-28 16:15:08 +00:00
parent cabbc3be5b
commit ec105d0993
1 changed files with 5 additions and 1 deletions

View File

@ -1004,7 +1004,11 @@ parenthesize the format string.
When memory buffers are passed as parameters to supply data to build
objects, as for the \samp{s} and \samp{s\#} formats, the required data
is copied. Buffers provided by the caller are never referenced by the
objects created by \cfunction{Py_BuildValue()}.
objects created by \cfunction{Py_BuildValue()}. In other words, if
your code invokes \cfunction{malloc()} and passes the allocated memory
to \cfunction{Py_BuildValue()}, your code is responsible for
calling \cfunction{free()} for that memory once
\cfunction{Py_BuildValue()} returns.
In the following description, the quoted form is the format unit; the
entry in (round) parentheses is the Python object type that the format