Function CDM_MACRO_RunSystemTool


Definition:#include <CDM.h>
Prototype:int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, const CDM_MACRO_SYSTEM_COLLECTION token, const char *Annotator, const int force);
Arguments:

system: A token representing an opened System. (const CDM_MACRO_SYSTEM)
token: A token representing an opened Document/Document in a System. (const const CDM_MACRO_SYSTEM_COLLECTION)
Annotator: The name of the Annotator (component) to apply. (const char *)
force: A boolean flag, specifying whether the Annotator will be applied anyway (true), or whether its applicability should be first examined (false). (const int)


Prototype:int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, CDM_Collection col, CDM_Document doc, const char *Annotator, const int force);
Arguments:

system: A token representing an opened System. (const CDM_MACRO_SYSTEM)
col: A Collection object (CDM_Collection)
doc: A Document object. (CDM_Document)
Annotator: The name of the Annotator (component) to apply. (const char *)
force: A boolean flag, specifying whether the Annotator will be applied anyway (true), or whether its applicability should be first examined (false). (const int)

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

Description:

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, const CDM_MACRO_SYSTEM_COLLECTION token, const char *Annotator, const int force):
This function will apply the specified Tool (through the Annotator parameter) on the Collection/Document represented by "token". If the perameter "force" is false (the default), the Annotator will be applied only if all the previous Annotators in the system have already run. If "force" is true, no check will be performed and the Annotator will be applied.

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, CDM_Collection col, CDM_Document doc, const char *Annotator, const int force):
This function will apply the specified Tool (through the Annotator parameter) on the Collection/Document specified through the "col" and "doc" parameters. If the perameter "force" is false (the default), the Annotator will be applied only if all the previous Annotators in the system have already run. If "force" is true, no check will be performed and the Annotator will be applied.

Return Value:

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, const CDM_MACRO_SYSTEM_COLLECTION token, const char *Annotator, const int force):
The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If an error occurs, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp). If all annotators run without errors, TCL_OK will be returned.

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, CDM_Collection col, CDM_Document doc, const char *Annotator, const int force):
The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If an error occurs, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp). If all annotators run without errors, TCL_OK will be returned.

Notes:

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, const CDM_MACRO_SYSTEM_COLLECTION token, const char *Annotator, const int force):
This function is equivelant to ::Macro::RunSystemTool (Tcl API).

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, CDM_Collection col, CDM_Document doc, const char *Annotator, const int force):
This function is equivelant to ::Macro::RunSystemTool (Tcl API).

See Also:

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, const CDM_MACRO_SYSTEM_COLLECTION token, const char *Annotator, const int force):
CDM_MACRO_OpenSystem, CDM_MACRO_EditSystem, CDM_MACRO_GetOpenedCollection, CDM_MACRO_GetOpenedDocument, CDM_MACRO_OpenInSystem, CDM_MACRO_RunSystemTool, CDM_MACRO_RunSystemTool, CDM_MACRO_DisplayViewer, ::Macro::RunSystemTool

int CDM_MACRO_RunSystemTool(const CDM_MACRO_SYSTEM system, CDM_Collection col, CDM_Document doc, const char *Annotator, const int force):
CDM_MACRO_OpenSystem, CDM_MACRO_EditSystem, CDM_MACRO_GetOpenedCollection, CDM_MACRO_GetOpenedDocument, CDM_MACRO_OpenInSystem, CDM_MACRO_RunSystemTool, CDM_MACRO_RunSystemTool, CDM_MACRO_DisplayViewer, ::Macro::RunSystemTool


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