diff options
Diffstat (limited to 'doc/SubstObj.3')
| -rw-r--r-- | doc/SubstObj.3 | 17 |
1 files changed, 5 insertions, 12 deletions
diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index f10e01d..ba0ee7c 100644 --- a/doc/SubstObj.3 +++ b/doc/SubstObj.3 @@ -3,12 +3,12 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" +'\" .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures" .so man.macros .BS .SH NAME -Tcl_SubstObj \- perform substitutions on Tcl values +Tcl_SubstObj \- perform substitutions on Tcl objects .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -22,9 +22,9 @@ 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 value containing the string to perform substitutions on. +A Tcl object containing the string to perform substitutions on. .AP int flags in -OR'ed combination of flag bits that specify which substitutions to +ORed combination of flag bits that specify which substitutions to perform. The flags \fBTCL_SUBST_COMMANDS\fR, \fBTCL_SUBST_VARIABLES\fR and \fBTCL_SUBST_BACKSLASHES\fR are currently supported, and \fBTCL_SUBST_ALL\fR is provided as a @@ -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 value which is returned as the result of the function. In the +output object 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. @@ -62,13 +62,6 @@ 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 "REFERENCE COUNT MANAGEMENT" -.PP -The \fIobjPtr\fR argument to \fBTcl_SubstObj\fR must not have a reference -count of zero. This function modifies the interpreter result, both on success -and on failure; the result of this function on success is exactly the current -interpreter result. Successful results should have their reference count -incremented if they are to be retained. .SH "SEE ALSO" subst(n) .SH KEYWORDS |