diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2012-11-09 20:11:35 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2012-11-09 20:11:35 (GMT) |
commit | 3bd3c81555c4dcf32b173945d8adb802a8f6b361 (patch) | |
tree | b8218d3628c1b820b55b71fa9a7694914f521e5a /doc/SubstObj.3 | |
parent | bd6d07883f6ee2874c3e6ba0b64d107e699a0c11 (diff) | |
parent | d677e8a8ae7188b1aebd47c054633273808d5764 (diff) | |
download | tcl-3bd3c81555c4dcf32b173945d8adb802a8f6b361.zip tcl-3bd3c81555c4dcf32b173945d8adb802a8f6b361.tar.gz tcl-3bd3c81555c4dcf32b173945d8adb802a8f6b361.tar.bz2 |
merge trunk
Diffstat (limited to 'doc/SubstObj.3')
-rw-r--r-- | doc/SubstObj.3 | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index 786b595..d5a52c3 100644 --- a/doc/SubstObj.3 +++ b/doc/SubstObj.3 @@ -8,7 +8,7 @@ .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_SubstObj \- perform substitutions on Tcl objects +Tcl_SubstObj \- perform substitutions on Tcl values .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -22,7 +22,7 @@ Interpreter in which to execute Tcl scripts and lookup variables. If an error occurs, the interpreter's result is modified to hold an error message. .AP Tcl_Obj *objPtr in -A Tcl object containing the string to perform substitutions on. +A Tcl value containing the string to perform substitutions on. .AP int flags in ORed combination of flag bits that specify which substitutions to perform. The flags \fBTCL_SUBST_COMMANDS\fR, @@ -36,7 +36,7 @@ The \fBTcl_SubstObj\fR function is used to perform substitutions on strings in the fashion of the \fBsubst\fR command. It gets the value of the string contained in \fIobjPtr\fR and scans it, copying characters and performing the chosen substitutions as it goes to an -output object which is returned as the result of the function. In the +output value which is returned as the result of the function. In the event of an error occurring during the execution of a command or variable substitution, the function returns NULL and an error message is left in \fIinterp\fR's result. |