diff Doc/api/api.tex @ 10170:7cf97658cae7 legacy-trunk

Be explicit about the reference count of the original value of the first parameter to PyString_Concat().
author Fred Drake <fdrake@acm.org>
date Mon, 15 Feb 1999 20:15:39 +0000
parents ddf861d84bbb
children a29192f2d47a
line wrap: on
line diff
--- a/Doc/api/api.tex	Mon Feb 15 19:29:08 1999 +0000
+++ b/Doc/api/api.tex	Mon Feb 15 20:15:39 1999 +0000
@@ -1737,8 +1737,12 @@
 
 \begin{cfuncdesc}{void}{PyString_Concat}{PyObject **string,
                                          PyObject *newpart}
-Creates a new string object in \var{*string} containing the contents
-of \var{newpart} appended to \var{string}.
+Creates a new string object in \var{*string} containing the
+contents of \var{newpart} appended to \var{string}.  The old value of
+\var{string} have its reference count decremented.  If the new string
+cannot be created, the old reference to \var{string} will still be
+discarded and the value of \var{*string} will be set to
+\NULL{}; the appropriate exception will be set.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{void}{PyString_ConcatAndDel}{PyObject **string,