Function CDM_MACRO_GetContainerSystem


Definition:#include <CDM.h>
Prototype:CDM_MACRO_SYSTEM CDM_MACRO_GetContainerSystem(const CDM_Collection col);
Arguments:

col: The Collection object. (const CDM_Collection)

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

Description:

This function will return a token for the System window in the graphical interface that contains this Collection.

Return Value:

The return value from this function will be a token (of type CDM_MACRO_SYSTEM) representing the opened System window. CDM does not own the returned token: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the token and the memory associated with it.

In case of an error, NULL will be returned and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Notes:

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

See Also:

CDM_MACRO_EditSystem, CDM_MACRO_GetOpenedCollection, CDM_MACRO_GetOpenedDocument, CDM_MACRO_OpenInSystem, CDM_MACRO_RunSystemComponent, CDM_MACRO_RunSystemTool, CDM_MACRO_DisplayViewer, CDM_Free, Tcl_DecrRefCount, ::Macro::OpenSystem


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