Function CDM_MACRO_OpenInSystem


Definition:#include <CDM.h>
Prototype:CDM_MACRO_SYSTEM_COLLECTION CDM_MACRO_OpenInSystem(const CDM_MACRO_SYSTEM system, const char *collection_name, const char *document_id);
Arguments:

system: A token representing an opened System. (const CDM_MACRO_SYSTEM)
collection_name: The name (path on disk) of the Collection to be opened. (const char *)
document_id: The Document ID of the Document to be opened (optional). (const char *)

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

Description:

This function will open a whole Collection or a Document inside a System.

Return Value:

The return value from this function will be a token (of type CDM_MACRO_SYSTEM) representing the opened Collection/Document. 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::OpenInSystem (Tcl API).

See Also:

CDM_MACRO_OpenSystem, 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::OpenInSystem


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