Function CDM_AnnotationContainsPosition


Definition:#include <CDM.h>
Prototype:int CDM_AnnotationContainsPosition(const CDM_Annotation Ann, const long Position);
Arguments:

Ann: The Annotation to be examined (CDM_Annotation)
Position: The position to me checked (long)

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

Description:

This function will check if the provided Annotation (specified through the "Annotation" parameter) contains in any of its spans the specified position.

Return Value:

This function will return 1 (true) if the Annotation contains the specified position in any of its spans. Else, 0 (false) will be returned.

In case of an error, -1 will be returned and an error message will be left at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_AnnotationContainsPosition (Tcl API).

See Also:

CDM_AnnotationMatchesRange, tip_AnnotationContainsPosition


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