Function CDM_MACRO_DisplayViewer


Definition:#include <CDM.h>
Prototype:int CDM_MACRO_DisplayViewer(const CDM_MACRO_SYSTEM system, const char *viewer_name, CDM_Document doc, const char *parameter1, const char *parameter2);
Arguments:

system: A token representing an opened System. (const CDM_MACRO_SYSTEM)
viewer_name: The name of the viewer to be shown. (const char *)
doc: A Document object. Either the Document or the Collection owning the Document must have been opened in the System specified through the "system" parameter. (CDM_Document)
parameter1: A paremeter that depends on the viewer to be displayed. It usually corrsponds to Annotation Type. (const char *)
parameter2: A paremeter that depends on the viewer to be displayed. It usually corrsponds to an Attribute. (const char *)

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

Description:

This function will display a graphical viewer over a Document opened in a System.

Return Value:

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:

This function is equivelant to ::Macro::DisplayViewer (Tcl API).

See Also:

::Macro::DisplayViewer


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