summaryrefslogtreecommitdiffstats
path: root/doc/CrtCommand.3
diff options
context:
space:
mode:
authorstanton <stanton>1998-10-05 17:35:53 (GMT)
committerstanton <stanton>1998-10-05 17:35:53 (GMT)
commit96be4fa0ab6cb9a0ef8b91883cb51e120e857cde (patch)
treebb9d2f700f6cdc5d4b3c8843c298b1c396eae3b0 /doc/CrtCommand.3
parentcb0491921471d22c09c1bc08dfc08304e6d6df0b (diff)
downloadtcl-96be4fa0ab6cb9a0ef8b91883cb51e120e857cde.zip
tcl-96be4fa0ab6cb9a0ef8b91883cb51e120e857cde.tar.gz
tcl-96be4fa0ab6cb9a0ef8b91883cb51e120e857cde.tar.bz2
added comment to clarify that it is not valid to modify argument
strings in a string-based Tcl command
Diffstat (limited to 'doc/CrtCommand.3')
-rw-r--r--doc/CrtCommand.39
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/CrtCommand.3 b/doc/CrtCommand.3
index f7f0e00..f2f6cea 100644
--- a/doc/CrtCommand.3
+++ b/doc/CrtCommand.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: CrtCommand.3,v 1.2 1998/09/14 18:39:47 stanton Exp $
+'\" RCS: @(#) $Id: CrtCommand.3,v 1.3 1998/10/05 17:35:53 stanton Exp $
'\"
.so man.macros
.TH Tcl_CreateCommand 3 "" Tcl "Tcl Library Procedures"
@@ -94,7 +94,12 @@ the command, \fIargc\fR giving the number of arguments (including
the command name) and \fIargv\fR giving the values of the arguments
as strings. The \fIargv\fR array will contain \fIargc\fR+1 values;
the first \fIargc\fR values point to the argument strings, and the
-last value is NULL.
+last value is NULL.
+.VS
+Note that the argument strings should not be modified as they may
+point to constant strings or may be shared with other parts of the
+interpreter.
+.VE
.PP
\fIProc\fR must return an integer code that is either \fBTCL_OK\fR, \fBTCL_ERROR\fR,
\fBTCL_RETURN\fR, \fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR. See the Tcl overview man page