Function CDM_Initialise


Definition:#include <CDM.h>
Prototype:int CDM_Initialise(const char *appName);
Arguments:

appName: A string containing the name of the application. It can also be the empty string "" (char *)

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

Description:

This function must be called when CDM is embeded inside a C/C++ application, where a Tcl interpreter is not available. This function will initialise all needed by the CDM internal structures. This function must be called only once within each application (although calling this function more than once is safe, as subsequent invocations are ignored).

Return Value:

If the CDM could not be initialised, TCL_ERROR will be returned. It is safe to call any CDM function if TCL_ERROR is returned. If CDM is succesfully initialised, TCL_OK will be returned.

Notes:

Please note that for embedding CDM under any application, Tcl must be installed, as CDM uses functions from the Tcl library.

See Also:

CDM_Finalise


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