Function CDM_Destroy


Definition:#include <CDM.h>
Prototype:int CDM_Destroy(char *Name);
Arguments:

Name: The Collection's Name (char *)

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

Description:

This function will delete the disk representation of a Collection object. The Name parameter must be the (absolute) path to the directory that holds the Collection. Having a Collection object, this information can be obtained through CDM_GetName.

Note that this function will only delete the current disk representation of a Collection. If the Collection is loaded in memory and we save the loaded Collection (with the help of CDM_Sync), then the representaion of the Collection in disk will be re-created.

Return Value:

The return value of this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If the Collection's directory cannot be removed, the return value will be TCL_ERROR and an error message describing the error will be left at the current active Tcl interpreter (CDM_Interp). If the deletion was done successfully, TCL_OK will be returned.

Notes:

Note that this function will delete the whole directory that holds the Collection, along with ALL the files in that directory. If the user has placed files inside the Collection's directory, these files will be also deleted.

This function is equivelant to tip_Destroy (Tcl API).

See Also:

CDM_GetName, tip_Destroy


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