Function CDM_NextAnnotations


Definition:#include <CDM.h>
Prototype:CDM_AnnotationSet CDM_NextAnnotations(CDM_Document Document, long Position);
Arguments:

Document: A Document object. (CDM_Document)
Position: Position in text. (long)


Prototype:CDM_AnnotationSet CDM_NextAnnotations(CDM_AnnotationSet Set, long Position);
Arguments:

Set: Annotation Set. (CDM_AnnotationSet)
Position: Requested position (int)

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

Description:

CDM_AnnotationSet CDM_NextAnnotations(CDM_Document Document, long Position):
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).

CDM_AnnotationSet CDM_NextAnnotations(CDM_AnnotationSet Set, long Position):
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:

CDM_AnnotationSet CDM_NextAnnotations(CDM_Document Document, long Position):
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_NextAnnotations(CDM_AnnotationSet Set, long Position):
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_NextAnnotations(CDM_Document Document, long Position):
This function is equivelant to tip_NextAnnotations (Tcl API).

CDM_AnnotationSet CDM_NextAnnotations(CDM_AnnotationSet Set, long Position):
This function is equivelant to tip_NextAnnotations (Tcl API).

See Also:

CDM_AnnotationSet CDM_NextAnnotations(CDM_Document Document, long Position):
CDM_Free, Tcl_DecrRefCount, tip_NextAnnotations

CDM_AnnotationSet CDM_NextAnnotations(CDM_AnnotationSet Set, long Position):
CDM_Free, Tcl_DecrRefCount, tip_NextAnnotations


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