Function tip_SetName


Prototype: tip_SetName(Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)
Name: The desired new Name of the Collection. (string)

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

Description:

This function will change the Name of the specified Collection. The Name of the Collection represents the (absolute) path of the Collection's disk representation. Changing the Name of a Collection will result into a new Collection representation in disk if the Collection is saved (through tip_Sync). Note that this function will not perform any checks on the value of the "Name" parameter. If an invalid path is given, or a path that corresponds to an existing file, no error will be returned by this function. (Although tip_Sync will return an error if the caller tries to save a Collection with an invalid Name.) *

Return Value:

This function will return a string that holds the new Collection Name.

In case of an error, an error message will be prompted. *

Notes:

This function is equivelant to CDM_SetName (C++ API).

See Also:

tip_Sync


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