Function CDM_NextAnnotations
|
|
|
|
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 their spans ranges are after
the specified text position (as given by the parameter "Position").
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. This function will always create and return a new Annotation set object,
even when the Document has no Annotations defined or no Annotations
exist that all their spans are beneath the specified text position.
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 their spans ranges are after
the specified text position (as given by the parameter "Position").
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. This function will always create and return a new Annotation set object,
even when the Annotation set has no Annotations defined or no Annotations
exist that all their spans are beneath the specified text position.
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_NextAnnotations (Tcl API). This function is equivelant to tip_NextAnnotations (Tcl API).
See Also:
CDM_Free, Tcl_DecrRefCount, tip_NextAnnotations CDM_Free, Tcl_DecrRefCount, tip_NextAnnotations
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.