Function CDM_CreateAnnotationSet


Definition:#include <CDM.h>
Prototype:CDM_AnnotationSet CDM_CreateAnnotationSet(void);
Arguments:

None: (void)

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

Description:

This function will create and return a new (and empty) Annotation Set object (of type CDM_AnnotationSet). This new Annotation Set can be used in order to place Annotation objects (of type CDM_Annotation) into it.

CDM does not own the returned object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

In case of an error, NULL will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Return Value:

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

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

Notes:

This function is equivelant to tip_CreateAnnotationSet (Tcl API).

See Also:

CDM_Free, Tcl_DecrRefCount, tip_CreateAnnotationSet


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