summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-02-15 20:15:39 (GMT)
committerFred Drake <fdrake@acm.org>1999-02-15 20:15:39 (GMT)
commit66b989c80594dba22bcb2e3a37aefca1c8824414 (patch)
tree6ca60b2ff2ed3a41636de9d53d8cafcd83734461 /Doc/api
parent4d33e4e1a83dac20269cc8a4a75dd2b7e73c417f (diff)
downloadcpython-66b989c80594dba22bcb2e3a37aefca1c8824414.zip
cpython-66b989c80594dba22bcb2e3a37aefca1c8824414.tar.gz
cpython-66b989c80594dba22bcb2e3a37aefca1c8824414.tar.bz2
Be explicit about the reference count of the original value of the
first parameter to PyString_Concat().
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/api.tex8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 58c2f45..02e31c9 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -1737,8 +1737,12 @@ Resturns a \NULL{} terminated representation of the contents of \var{string}.
\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,