Function CDM_OpenCollection


Definition:#include <CDM.h>
Prototype:CDM_Collection CDM_OpenCollection(CDM_CONST char *Name);
Arguments:

Name: The Name of the Collection (absolute path). (char *)

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

Description:

This function will load the Collection from the directory specified by the "Name" argument. If the target that "Name" points is a directory that is readable by the current user and contains a valid Collection specification (either in native or in GATE format), then this Collection will be loaded from disk to the memory. A new Collection object (of type CDM_Collection) will be created and returned to the caller.

Return Value:

This function will construct and return a Collection object (of type CDM_Collection) that will represent the Collection stored at the directory specified by the "Name" parameter. The caller must use this object in order to refer to the newly opened Collection and must use the function CDM_Close in order to close the Collection and free the occupied memory if the Collection is not needed any more.

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.

Notes:

This function is equivelant to tip_OpenCollection (Tcl API).

See Also:

CDM_Close, tip_OpenCollection


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