Function CDM_MACRO_GetOpenedCollection


Definition:#include <CDM.h>
Prototype:CDM_Collection CDM_MACRO_GetOpenedCollection(const CDM_MACRO_SYSTEM_COLLECTION token);
Arguments:

token: A token representing an opened Collection/Document in a System. (const const CDM_MACRO_SYSTEM_COLLECTION)

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

Description:

This function will return the Collection object (of type CDM_Collection) that is represented by the provided token. The token must have been retrieved with a previous call to either CDM_MACRO_OpenSystem or CDM_MACRO_EditSystem.

Return Value:

This function will return the Collection object (of type CDM_Collection) that is represented by the provided token.

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

Note that the returned object is property of the CDM and should never be freed or modified in any way by the caller.

See Also:

CDM_MACRO_OpenSystem, CDM_MACRO_EditSystem, CDM_MACRO_GetOpenedDocument


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