diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2002-10-22 12:16:52 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2002-10-22 12:16:52 (GMT) |
commit | 5356bb251e4978b7dc52fb21ee811b516ef2329f (patch) | |
tree | 78bb48178b7ca498830be71dfb41beb86e600845 /doc/StringObj.3 | |
parent | bcd296f1929aa83bdf5693c9fbc268c61a55784e (diff) | |
download | tcl-5356bb251e4978b7dc52fb21ee811b516ef2329f.zip tcl-5356bb251e4978b7dc52fb21ee811b516ef2329f.tar.gz tcl-5356bb251e4978b7dc52fb21ee811b516ef2329f.tar.bz2 |
Documentation didn't say that the UTF-8-rep of a Tcl_Obj was UTF-8 (sans NUL)!
[Bug 624919]
Diffstat (limited to 'doc/StringObj.3')
-rw-r--r-- | doc/StringObj.3 | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3 index df2eafc..8d43dc6 100644 --- a/doc/StringObj.3 +++ b/doc/StringObj.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StringObj.3,v 1.12 2002/06/26 11:50:52 msofer Exp $ +'\" RCS: @(#) $Id: StringObj.3,v 1.13 2002/10/22 12:16:53 dkf Exp $ '\" .so man.macros .TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures" @@ -72,12 +72,17 @@ int Tcl_Obj * \fBTcl_ConcatObj\fR(\fIobjc, objv\fR) .SH ARGUMENTS -.AS Tcl_Interp *appendObjPtr in/out +.AS "CONST Tcl_UniChar" *appendObjPtr in/out .AP "CONST char" *bytes in -Points to the first byte of an array of bytes +.VS 8.1 +Points to the first byte of an array of UTF-8-encoded bytes used to set or append to a string object. -This byte array may contain embedded null bytes -unless \fIlength\fR is negative. +This byte array should not contain embedded null bytes +unless \fIlength\fR is negative. (Applications needing null bytes +should represent them as the two-byte sequence \fI\\700\\600\fR, use +\fBTcl_ExternalToUtf\fR to convert, or \fBTcl_NewByteArrayObj\fR if +the string is a collection of uninterpreted bytes.) +.VE 8.1 .AP int length in The number of bytes to copy from \fIbytes\fR when initializing, setting, or appending to a string object. |