OCDM_Tcl Class Reference

The OCDM_Tcl class provides an easy way to interact with the main scripting language (Tcl). It provides facilities for executing Tcl code, writting to Tcl channels, etc.

#include <OCDM.h>

List of all members.

Public Member Functions

 OCDM_Tcl ()
 The constructor.
 ~OCDM_Tcl ()
 The destructor.
int eval (const char *tcl_code) const
 Evaluates Tcl code contained in a string.
int exec (const char *command) const
 Executes an operating system command by using the Tcl "exec" command.
const char * GetResult (void) const


Constructor & Destructor Documentation

OCDM_Tcl (  ) 

~OCDM_Tcl (  ) 


Member Function Documentation

int eval ( const char *  tcl_code  )  const

Description:
This method can be used to execute Tcl code. This function calls the Tcl_Eval function from the Tcl C library. The string should be a proper UTF-8 string. The string is parsed and executed directly instead of compiling it and executing the bytecodes.
Arguments:
  • tcl_code: A NULL terminated UTF-8 string.
Returns:
The return value from this method is a Tcl completion code (with one of the values OCDM_OK, OCDM_ERROR, OCDM_RETURN, OCDM_BREAK, or OCDM_CONTINUE, or possibly some other integer value originating in an extension. In case of an error, an OCDM_Exception is thrown.

int exec ( const char *  command  )  const

const char * GetResult ( void   )  const


Generated on Tue Jun 26 17:40:44 2007 for OCDM by  doxygen 1.5.2