Function CDM_SetActiveInterpreter


Definition:#include <CDM.h>
Prototype:int CDM_SetActiveInterpreter(Tcl_Interp *Interpreter);
Arguments:

Interp: A pointer to a valid Tcl Interpreter (Tcl_Interp *)

C/C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

This function will update the CDM current interpreter to the interpreter specified throught the "Interp" parameter. The CDM current interpreter is accessible through the global variable CDM_Interp (of type Tcl_Interp *). This interpreter can be used in any case a Tcl interpreter is required (either as a parameter to a Tcl library fucntion or to save an error message). The value of CDM_Interp should never be changed directly but only through this function. Finally, the value of the "Interp" parameter should be a valid Tcl interpreter, preferably not a safe one.

Return Value:

The return value of this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If the value of the global variable CDM_Interp cannot be changed, the return value will be TCL_ERROR. No error message will be left at the current active Tcl interpreter (CDM_Interp). If the update was done successfully, TCL_OK will be returned.

Notes:

CDM_Interp will always point to the main Tcl interpreter of the application after CDM initialises.

See Also:

CDM_GetActiveInterpreter, CDM_Interp


Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.