Function CDM_Sync


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

Collection: A Collection object. (CDM_Collection)


Prototype:int CDM_Sync(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_Sync(CDM_Collection Collection):
This function will save a Collection object in disk. If the Collection object has never been saved again, then this function will create the directory that the Name of the Collection specifies. A representation of the Collection will be saved in this directory. If the directory already exists it will be overwritten. If the directory cannot be created an error condition will be returned.

int CDM_Sync(CDM_Document Document):
This function will save a Document object in disk. If the Document object has never been saved again, then this function will create a file according to the Id the specified Document. A representation of the Document will be saved in this file. If the file already exists it will be overwritten. If the file cannot be created an error condition will be returned.

Return Value:

int CDM_Sync(CDM_Collection Collection):
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 Collection is successfully saved, 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).

int CDM_Sync(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 saved, 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_Sync(CDM_Collection Collection):
The user is not expected to modify directories that hold Collections in any way. Modifing any of the files under the Collection directory may result in a corrupted, unreadble Collection.

This function is equivelant to tip_Sync (Tcl API).

int CDM_Sync(CDM_Document Document):
The user is not expected to modify file that hold Documents in any way. Modifing any Document file may result in a corrupted, unreadble Document.

This function is equivelant to tip_Sync (Tcl API).

See Also:

int CDM_Sync(CDM_Collection Collection):
tip_Sync

int CDM_Sync(CDM_Document Document):
tip_Sync


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