Tcl\_RecordAndEvalObj(3) Tcl Library Procedures Tcl\_RecordAndEvalObj(3)

```

```

# [NAME](#NAME)

Tcl\_RecordAndEvalObj - save command on history list before evaluating

# [SYNOPSIS](#SYNOPSIS)

```
#include <tcl.h>

int
Tcl_RecordAndEvalObj(interp, cmdPtr, flags)
```

# [ARGUMENTS](#ARGUMENTS)

Tcl\_Interp *\*interp* (in)

Tcl interpreter in which to evaluate command.

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 instead of the current stack level.

```
    
```

# [DESCRIPTION](#DESCRIPTION)

**Tcl\_RecordAndEvalObj** is invoked to record a command as an event on the history 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 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.

# [REFERENCE COUNT MANAGEMENT](#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](#SEE_ALSO)

Tcl\_EvalObjEx, Tcl\_GetObjResult

# [KEYWORDS](#KEYWORDS)

command, event, execute, history, interpreter, value, record

8.0 Tcl

---

Document: Tcl_RecordAndEvalObj(3) from tcl 9.1.0-r0 (Chainguard OS)
Source: https://downloads.sourceforge.net/project/tcl/Tcl/9.1.0/tcl9.1.0-src.tar.gz