Function CDM_Close


Definition:#include <CDM.h>
Prototype:int CDM_Close(CDM_Collection Collection);
Arguments:

Collection: Collection Object to be closed. (CDM_Collection)


Prototype:int CDM_Close(CDM_Document Document);
Arguments:

Document: A Document object. (CDM_Document)

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

Description:

int CDM_Close(CDM_Collection Collection):
Closes the given Collection and frees all the memory occupied by the Collection and its Documents. All the deleted objects will also be unregistered from the current Tcl interpreter (CDM_Interp).

int CDM_Close(CDM_Document Document):
This function will close the given (opened) Document object. All the objects that the Document to be closed owns, as well the Document object itself, will be deleted from memory and will be unregistered from the current Tcl interpreter (CDM_Interp). The Document object must be a valid CDM Document (of type CDM_Document) and must have been returned by one of the functions CDM_GetByExternalId, CDM_GetDocument, CDM_FirstDocument, CDM_NextDocument or CDM directly (as a parameter to the main function of a module).

Note that this function will not save the specified Document. In order for the Document to be saved, the caller must previously call CDM_Sync.

Return Value:

int CDM_Close(CDM_Collection Collection):
The return value from this function will be a standart Tcl completion code (of type int). As this function ignores any possible errors, the return value will always be TCL_OK.

int CDM_Close(CDM_Document Document):
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 the requested Document is successfully closed, TCL_OK will be returned. In case of an error, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp).

Notes:

int CDM_Close(CDM_Collection Collection):
This function is equivelant to tip_Close (Tcl API).

int CDM_Close(CDM_Document Document):
This function will not save the specified Document before deleting it from memory.

This function is equivelant to tip_Close (Tcl API).

See Also:

int CDM_Close(CDM_Collection Collection):
tip_Close

int CDM_Close(CDM_Document Document):
CDM_GetByExternalId, CDM_GetDocument, CDM_FirstDocument, CDM_NextDocument, CDM_Sync, tip_Close


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