Function CDM_AnnotationsInRange


Definition:#include <CDM.h>
Prototype:CDM_AnnotationSet CDM_AnnotationsInRange(CDM_Document Document, long Start, long End);
Arguments:

Document: A Document object. (CDM_Document)
Start: The start of the desired range. (long)
End: The end of the desired range. (long)


Prototype:CDM_AnnotationSet CDM_AnnotationsInRange(CDM_AnnotationSet Set, long Start, long End);
Arguments:

Set: Annotation Set object. (CDM_AnnotationSet)
Start: The start of the desired range. (long)
End: The end of the desired range. (long)

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

Description:

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_Document Document, long Start, long End):
This function will return a new Annotation set object (of type CDM_AnnotationSet) that will contain all the Annotations of the specified Document that have at least one span within the specified range (["Start", "End"]). CDM will 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.

This function will always create and return a new AnnotationSet object, even when the Document has no Annotations defined or when no Annotation is found that resides inside the specified range. (In this case an empty Annotation set will be returned.)

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

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_AnnotationSet Set, long Start, long End):
This function will return a new Annotation set object (of type CDM_AnnotationSet) that will contain all the Annotations of the specified Annotation Set that have at least one span within the specified range (["Start", "End"]). CDM will 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.

This function will always create and return a new AnnotationSet object, even when the original Annotations set did not have any Annotations defined, or when no Annotation from the given Annotation set is found to reside inside the specified range. (In this case an empty Annotation set will be returned.)

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:

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_Document Document, long Start, long End):
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.

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

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_AnnotationSet Set, long Start, long End):
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.

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:

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_Document Document, long Start, long End):
This function is equivelant to tip_AnnotationsInRange (Tcl API).

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_AnnotationSet Set, long Start, long End):
This function is equivelant to tip_AnnotationsInRange (Tcl API).

See Also:

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_Document Document, long Start, long End):
CDM_AnnotationsAt, CDM_AnnotationsContaining, CDM_AnnotationsMatchingRange, CDM_Free, Tcl_DecrRefCount, tip_AnnotationsInRange

CDM_AnnotationSet CDM_AnnotationsInRange(CDM_AnnotationSet Set, long Start, long End):
CDM_AnnotationsAt, CDM_AnnotationsContaining, CDM_AnnotationsMatchingRange, CDM_Free, Tcl_DecrRefCount, tip_AnnotationsInRange


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