Tcl_RecordAndEvalObj(3) Tcl Library Procedures Tcl_RecordAndEvalObj(3) ________________________________________________________________________________ NAME Tcl_RecordAndEvalObj - save command on history list before evaluating SYNOPSIS #include <tcl.h> int Tcl_RecordAndEvalObj(interp, cmdPtr, flags) ARGUMENTS Tcl_Interp *interp (in) Tcl interpreter in which to evaluate com- mand. Tcl_Obj *cmdPtr (in) Points to a Tcl value containing a command (or sequence of commands) to execute. int flags (in) An OR'ed combination of flag bits. TCL_NO_EVAL means record the command but do not evaluate it. TCL_EVAL_GLOBAL means evaluate the command at global level in- stead of the current stack level. ________________________________________________________________________________ DESCRIPTION Tcl_RecordAndEvalObj is invoked to record a command as an event on the his- tory list and then execute it using Tcl_EvalObjEx. It returns a completion code such as TCL_OK just like Tcl_EvalObjEx, as well as a result value con- taining additional information (a result value or error message) that can be retrieved using Tcl_GetObjResult. If you do not want the command recorded on the history list then you should invoke Tcl_EvalObjEx instead of Tcl_RecordAndEvalObj. Normally Tcl_RecordAndEvalObj is only called with top-level commands typed by the user, since the purpose of history is to allow the user to re-issue recently invoked commands. If the flags argu- ment contains the TCL_NO_EVAL bit then the command is recorded without be- ing evaluated. REFERENCE COUNT MANAGEMENT The reference count of the cmdPtr argument to Tcl_RecordAndEvalObj must be at least 1. This function will modify the interpreter result; do not use an existing result as cmdPtr directly without incrementing its reference count. SEE ALSO Tcl_EvalObjEx, Tcl_GetObjResult KEYWORDS command, event, execute, history, interpreter, value, record Tcl 8.0 Tcl_RecordAndEvalObj(3)
Want to link to this manual page? Use this URL:
<https://man.FreeBSD.org/cgi/man.cgi?query=Tcl_RecordAndEvalObj.tcl90&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>