Function CDM_GetName


Definition:#include <CDM.h>
Prototype:char * CDM_GetName(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype:char * CDM_GetName(CDM_Attribute Attribute);
Arguments:

Attribute: Attribute (CDM_Attribute)

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

Description:

char * CDM_GetName(CDM_Collection Collection):
This function will return the Name of the specified Collection. This value will be the (absolute) full path to the directory that contains the disk representation of the specified Collection. The returned value will be encoded using the UTF-8 encoding (thus enabling the existance of non Latin characters in the value).

The return value will be of type char* and will be owned by CDM.

char * CDM_GetName(CDM_Attribute Attribute):
Returns Attribute's Name...

Return Value:

char * CDM_GetName(CDM_Collection Collection):
This function returns a UTF-8 string that represents the Name of the specified Collection (the disk (absolute) path of the Collection in disk).

If an error occurs, then NULL will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Note that the returned object is property of the CDM and should never be freed or modified in any way by the caller.

char * CDM_GetName(CDM_Attribute Attribute):

Notes:

char * CDM_GetName(CDM_Collection Collection):
This function is equivelant to tip_GetName (Tcl API).

char * CDM_GetName(CDM_Attribute Attribute):

See Also:

char * CDM_GetName(CDM_Collection Collection):
CDM_SetName, tip_GetName

char * CDM_GetName(CDM_Attribute Attribute):


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