Function CDM_GetAnnotations


Definition:#include <CDM.h>
Prototype:CDM_AnnotationSet CDM_GetAnnotations(CDM_Document Document);
Arguments:

Document: A Document object. (CDM_Document)

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

Description:

This function will create and return a new object (of type CDM_AnnotationSet) that contains all the Annotations that the specified Document currently has. CDM does not own this object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

Note that this function will always create and return a new Annotation set object, even when the Document has no Annotations defined. (In this case an empty Annotation set will be returned.)

Return Value:

This function returns an Annotation set object (of type CDM_AnnotationSet). The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

Notes:

This function is equivelant to tip_GetAnnotations (Tcl API).

See Also:

CDM_Free, Tcl_DecrRefCount, tip_GetAnnotations


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