Function CDM_ReconstructAnnotation


Definition:#include <CDM.h>
Prototype:CDM_Annotation CDM_ReconstructAnnotation(CDM_Annotation Annotation);
Arguments:

Annotation: The Annotation object that is to be reconstucted. (CDM_Annotation)

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

Description:

This function accepts as argument a valid Annotation object (of type CDM_Annotation). This function will construct and return a new Annotation object that will be an exact copy of the provided one. The only difference will be that the returned Annotation object will utilise elements from the object cache that is managed internally by CDM. As a result the returned object will normally require less memory to be stored than the provided one, as it will re-use elements already in use by other CDM objects.

This function should be used on Annotation objects that originate from an unknown source. For example, if an Annotation object is stored in a file and then red back as a string, it will not use cached by the CDM objects. It will be a good idea if the caller created a new object by calling this function and delete the object red from the file by either calling Tcl_DecrRefCount or CDM_Free.

Return Value:

This function returns a new Annotation object (of type CDM_Annotation) that is an exact copy of the porvided Annotation object, but requires less memory due to re-using cached objects.

In case of an error (i.e. the specified object is not a valid Annotation object) NULL will be returned and an error message will be left at the current active interpreter (CDM_Interp).

The returned object is not property of CDM and the caller is responsible to free this object when it is no longer needed by either calling Tcl_DecrRefCount or CDM_Free.

Notes:

This function is equivelant to tip_ReconstructAnnotation (Tcl API).

See Also:

CDM_ReconstructAttribute, CDM_Free, Tcl_DecrRefCount, tip_ReconstructAnnotation


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