diff options
| author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2018-05-23 20:09:24 (GMT) |
|---|---|---|
| committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2018-05-23 20:09:24 (GMT) |
| commit | ca0f6f2273f4dd8d7b7449a4da43e34d5a98d4f2 (patch) | |
| tree | 3e0b07f6812a5848ee549cc167985bb03acf98da /doc/StringObj.3 | |
| parent | b013797f961380e6a2ddd366c96c570d736bd746 (diff) | |
| parent | a9e7c22c38a58f2248f2bd51529411914cd16e06 (diff) | |
| download | tcl-ca0f6f2273f4dd8d7b7449a4da43e34d5a98d4f2.zip tcl-ca0f6f2273f4dd8d7b7449a4da43e34d5a98d4f2.tar.gz tcl-ca0f6f2273f4dd8d7b7449a4da43e34d5a98d4f2.tar.bz2 | |
merge trunk
Diffstat (limited to 'doc/StringObj.3')
| -rw-r--r-- | doc/StringObj.3 | 5 |
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 |