Function tip_AnnotationsAt


Prototype: tip_AnnotationsAt(Document);
Arguments:

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


Prototype: tip_AnnotationsAt(Annotation);
Arguments:

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

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

Description:

tip_AnnotationsAt(Document):
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, an error message will be prompted.

tip_AnnotationsAt(Annotation):

Return Value:

tip_AnnotationsAt(Document):
This function returns an Annotation set object (of type CDM_AnnotationSet). The caller is responsible to free this object through Tcl_DecrRefCount or tip_Free.

If an error occurs, an error message will be prompted.

tip_AnnotationsAt(Annotation):

Notes:

tip_AnnotationsAt(Document):
This function is equivelant to CDM_AnnotationsAt (C++ API).

tip_AnnotationsAt(Annotation):

See Also:

tip_AnnotationsAt(Document):
tip_AnnotationsContaining, tip_AnnotationsInRange, tip_AnnotationsMatchingRange, tip_Free, Tcl_DecrRefCount

tip_AnnotationsAt(Annotation):


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