Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Tcl_RecordAndEval(3)	     Tcl Library Procedures	    Tcl_RecordAndEval(3)

________________________________________________________________________________

NAME
     Tcl_RecordAndEval - save command on history list before evaluating

SYNOPSIS
     #include <tcl.h>

     int
     Tcl_RecordAndEval(interp, cmd, flags)

ARGUMENTS
     Tcl_Interp *interp (in)	      Tcl  interpreter in which to evaluate com-
				      mand.

     const char *cmd (in)	      Command (or sequence of commands) to  exe-
				      cute.

     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_RecordAndEval is invoked to record a command as an event on the history
     list  and	then  execute  it  using  Tcl_Eval  (or  Tcl_GlobalEval  if  the
     TCL_EVAL_GLOBAL bit is set in flags).  It returns a completion code such as
     TCL_OK  just  like  Tcl_Eval and it leaves information in the interpreter's
     result.  If you do not want the command recorded on the history  list  then
     you   should   invoke  Tcl_Eval  instead  of  Tcl_RecordAndEval.	Normally
     Tcl_RecordAndEval 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-in-
     voked  commands.	If  the flags argument contains the TCL_NO_EVAL bit then
     the command is recorded without being evaluated.

     Note that Tcl_RecordAndEval has been largely replaced  by	the  value-based
     procedure Tcl_RecordAndEvalObj.  That value-based procedure records and op-
     tionally executes a command held in a Tcl value instead of a string.

SEE ALSO
     Tcl_RecordAndEvalObj

KEYWORDS
     command, event, execute, history, interpreter, record

Tcl				       7.4		    Tcl_RecordAndEval(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=Tcl_RecordAndEval.tcl86&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help