Function CDM_AnnotationsContaining
|
|
|
|
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 include the specified text position (as given
by the parameter "Position") into 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.
(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 Document that include the two specified text positions
(as given by the parameters "Position1" and "Position2")
into 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 positions into its span.
(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 include the specified text position
(as given by the parameter "Position") into 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 original Annotations set did not have any Annotations
defined, or when no Annotation
is found that includes the specified text position into its span.
(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 include the specified texts positions
(as given by the parameters "Position1" and "Position2")
into 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 original Annotations set did not have any Annotations
defined, or when no Annotation
is found that includes the specified text position into its span.
(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).
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_AnnotationsContaining (Tcl API). This function is equivelant to tip_AnnotationsContaining (Tcl API). This function is equivelant to tip_AnnotationsContaining (Tcl API). This function is equivelant to tip_AnnotationsContaining (Tcl API).
See Also:
CDM_AnnotationsAt, CDM_AnnotationsInRange, CDM_AnnotationsMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_AnnotationsContaining CDM_AnnotationsAt, CDM_AnnotationsInRange, CDM_AnnotationsMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_AnnotationsContaining CDM_AnnotationsAt, CDM_AnnotationsInRange,
CDM_AnnotationsMatchingRange, CDM_Free,
Tcl_DecrRefCount, tip_AnnotationsContaining CDM_AnnotationsAt, CDM_AnnotationsInRange,
CDM_AnnotationsMatchingRange, CDM_Free,
Tcl_DecrRefCount, tip_AnnotationsContaining
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.