Function CDM_AnnotationsAt


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

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


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

Set: Annotation Set object. (CDM_AnnotationSet)
Position: Position in text. (long)

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

Description:

CDM_AnnotationSet CDM_AnnotationsAt(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 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).

CDM_AnnotationSet CDM_AnnotationsAt(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 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:

CDM_AnnotationSet CDM_AnnotationsAt(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_AnnotationsAt(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_AnnotationsAt(CDM_Document Document, long Position):
This function is equivelant to tip_AnnotationsAt (Tcl API).

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

See Also:

CDM_AnnotationSet CDM_AnnotationsAt(CDM_Document Document, long Position):
CDM_AnnotationsContaining, CDM_AnnotationsInRange, CDM_AnnotationsMatchingRange, CDM_Free, Tcl_DecrRefCount, tip_AnnotationsAt

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