manpagez: man pages & more
man RecEvalObj(3)
Home | html | info | man
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  interpreter  in which to evaluate command.  Points to a Tcl object
       containing a command (or sequence of commands) to  execute.   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 instead of the current stack level.



DESCRIPTION

       Tcl_RecordAndEvalObj  is invoked to record a command as an event on the
       history list and then execute it using Tcl_EvalObjEx  (or  Tcl_GlobalE-
       valObj  if the TCL_EVAL_GLOBAL bit is set in flags).  It returns a com-
       pletion code such as TCL_OK just  like  Tcl_EvalObjEx,  as  well  as  a
       result  object  containing  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  argument  contains  the
       TCL_NO_EVAL bit then the command is recorded without being evaluated.



SEE ALSO

       Tcl_EvalObjEx(3), Tcl_GetObjResult(3)



KEYWORDS

       command, event, execute, history, interpreter, object, record



Tcl                                   8.0              Tcl_RecordAndEvalObj(3)

RecEvalObj 8.5.4 - Generated Wed Aug 20 18:28:25 CDT 2008
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.