Function tip_Sync


Prototype: tip_Sync(Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype: tip_Sync(Document);
Arguments:

Collection: A Collection object. (CDM_Collection)

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

Description:

tip_Sync(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.

tip_Sync(Document):

Return Value:

tip_Sync(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).

tip_Sync(Document):

Notes:

tip_Sync(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 CDM_Sync (C++ API).

tip_Sync(Document):

See Also:

tip_Sync(Collection):
CDM_Sync

tip_Sync(Document):


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