diff options
Diffstat (limited to 'doc/SubstObj.3')
| -rw-r--r-- | doc/SubstObj.3 | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index 9f016c0..786b595 100644 --- a/doc/SubstObj.3 +++ b/doc/SubstObj.3 @@ -16,7 +16,7 @@ Tcl_SubstObj \- perform substitutions on Tcl objects Tcl_Obj * \fBTcl_SubstObj\fR(\fIinterp, objPtr, flags\fR) .SH ARGUMENTS -.AS Tcl_Interp **termPtr; +.AS Tcl_Interp **termPtr .AP Tcl_Interp *interp in Interpreter in which to execute Tcl scripts and lookup variables. If an error occurs, the interpreter's result is modified to hold an error @@ -30,7 +30,6 @@ perform. The flags \fBTCL_SUBST_COMMANDS\fR, currently supported, and \fBTCL_SUBST_ALL\fR is provided as a convenience for the common case where all substitutions are desired. .BE - .SH DESCRIPTION .PP The \fBTcl_SubstObj\fR function is used to perform substitutions on @@ -51,19 +50,19 @@ When the \fBTCL_SUBST_VARIABLES\fR bit is set in \fIflags\fR, sequences that look like variable substitutions for Tcl commands are replaced by the contents of the named variable. .PP -When th \fBTCL_SUBST_COMMANDS\fR bit is set in \fIflags\fR, sequences +When the \fBTCL_SUBST_COMMANDS\fR bit is set in \fIflags\fR, sequences that look like command substitutions for Tcl commands are replaced by -the result of evaluating that script. Where an uncaught continue -exception occurs during the evaluation of a command substitution, an -empty string is substituted for the command. Where an uncaught break -exception occurs during the evaluation of a command substitution, the +the result of evaluating that script. Where an uncaught +.QW "continue exception" +occurs during the evaluation of a command substitution, an +empty string is substituted for the command. Where an uncaught +.QW "break exception" +occurs during the evaluation of a command substitution, the result of the whole substitution on \fIobjPtr\fR will be truncated at the point immediately before the start of the command substitution, and no characters will be added to the result or substitutions performed after that point. - .SH "SEE ALSO" subst(n) - .SH KEYWORDS backslash substitution, command substitution, variable substitution |