summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/concrete.tex10
1 files changed, 7 insertions, 3 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index af026ff..001d0ad 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -995,9 +995,13 @@ following functions. Support is optimized if Python's own
wchar_t *w,
int size}
Copies the Unicode object contents into the \ctype{wchar_t} buffer
- \var{w}. At most \var{size} \ctype{wchar_t} characters are copied.
- Returns the number of \ctype{wchar_t} characters copied or -1 in
- case of an error.
+ \var{w}. At most \var{size} \ctype{wchar_t} characters are copied
+ (excluding a possibly trailing 0-termination character). Returns
+ the number of \ctype{wchar_t} characters copied or -1 in case of an
+ error. Note that the resulting \ctype{wchar_t} string may or may
+ not be 0-terminated. It is the responsibility of the caller to make
+ sure that the \ctype{wchar_t} string is 0-terminated in case this is
+ required by the application.
\end{cfuncdesc}