Function CDM_AnnotationsContaining


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

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


Prototype:CDM_AnnotationSet CDM_AnnotationsContaining(CDM_Document Document, long Position1, long Position2);
Arguments:

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


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

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


Prototype:CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position1, long Position2);
Arguments:

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

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

Description:

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

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_Document Document, long Position1, long Position2):
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).

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

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position1, long Position2):
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:

CDM_AnnotationSet CDM_AnnotationsContaining(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_AnnotationsContaining(CDM_Document Document, long Position1, long Position2):
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_AnnotationsContaining(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).

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position1, long Position2):
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_AnnotationsContaining(CDM_Document Document, long Position):
This function is equivelant to tip_AnnotationsContaining (Tcl API).

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_Document Document, long Position1, long Position2):
This function is equivelant to tip_AnnotationsContaining (Tcl API).

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

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position1, long Position2):
This function is equivelant to tip_AnnotationsContaining (Tcl API).

See Also:

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

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_Document Document, long Position1, long Position2):
CDM_AnnotationsAt, CDM_AnnotationsInRange, CDM_AnnotationsMatchingRange, CDM_Free, Tcl_DecrRefCount, tip_AnnotationsContaining

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position):
CDM_AnnotationsAt, CDM_AnnotationsInRange, CDM_AnnotationsMatchingRange, CDM_Free, Tcl_DecrRefCount, tip_AnnotationsContaining

CDM_AnnotationSet CDM_AnnotationsContaining(CDM_AnnotationSet Set, long Position1, long Position2):
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.