summaryrefslogtreecommitdiffstats
path: root/doc/StringObj.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2018-04-20 10:18:29 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2018-04-20 10:18:29 (GMT)
commit0569fc46c844408dcdfbdeda711a3395967cb412 (patch)
tree64da1872a9c17cbb242d302c9f47f115664f156c /doc/StringObj.3
parent697d8c5398b041a3584259d54b99bc7027b2588a (diff)
parentca5638e01f9fc9f3371e252ceb9f4c1cb6144c09 (diff)
downloadtcl-0569fc46c844408dcdfbdeda711a3395967cb412.zip
tcl-0569fc46c844408dcdfbdeda711a3395967cb412.tar.gz
tcl-0569fc46c844408dcdfbdeda711a3395967cb412.tar.bz2
merge 8.7
Diffstat (limited to 'doc/StringObj.3')
-rw-r--r--doc/StringObj.35
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index cca5014..fed362c 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -37,7 +37,7 @@ Tcl_UniChar *
Tcl_UniChar *
\fBTcl_GetUnicode\fR(\fIobjPtr\fR)
.sp
-Tcl_UniChar
+int
\fBTcl_GetUniChar\fR(\fIobjPtr, index\fR)
.sp
int
@@ -201,7 +201,8 @@ where the caller does not need the length of the unicode string
representation.
.PP
\fBTcl_GetUniChar\fR returns the \fIindex\fR'th character in the
-value's Unicode representation.
+value's Unicode representation. If the index is out of range or
+it references a low surrogate preceded by a high surrogate, it returns -1;
.PP
\fBTcl_GetRange\fR returns a newly created value comprised of the
characters between \fIfirst\fR and \fIlast\fR (inclusive) in the