Function CDM_SortAnnotationSet


Definition:#include <CDM.h>
Prototype:CDM_AnnotationSet CDM_SortAnnotationSet(CDM_AnnotationSet Set);
Arguments:

Set: The Annotation set to be sorted (CDM_AnnotationSet)

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

Description:

This function will sort the Annotations contained in the provided Annotation set, according to their Span sets.

Return Value:

This function will create and return a new AnnotationSet object, that will contain all the Annotations contained in the provided by the "Set" parameter set, sorted by their span ranges. For more information about the sorting order, please refer to the CDM_CompareAnnotations function.

Note that 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. In case of an error, NULL will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_SortAnnotationSet (Tcl API).

See Also:

CDM_SelectAnnotationsSorted, CDM_CompareAnnotations, tip_SortAnnotationSet, lsort


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