Function CDM_AnnotationsAt
|
|
|
|
Description:
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 the specified text position (as given
by the parameter "Position") as a start position in any of their spans.
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. This function will always create and return a new Annotation set object,
even when the Document has no Annotations defined or when no Annotation
is found that includes the specified text position into its span set.
(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).
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 the specified text position (as given
by the parameter "Position") as a start position in any of their spans.
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. This function will always create and return a new Annotation set object,
even when the Annotation set has no Annotations defined or
when no Annotation
is found that includes the specified text position into its span set.
(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:
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).
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:
This function is equivelant to tip_AnnotationsAt (Tcl API). This function is equivelant to tip_AnnotationsAt (Tcl API).
See Also:
CDM_AnnotationsContaining, CDM_AnnotationsInRange,
CDM_AnnotationsMatchingRange, CDM_Free,
Tcl_DecrRefCount, tip_AnnotationsAt CDM_AnnotationsContaining, CDM_AnnotationsInRange,
CDM_AnnotationsMatchingRange, CDM_Free,
Tcl_DecrRefCount, tip_AnnotationsAt
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.