Function CDM_FirstAnnotationContaining
|
|
Definition: | #include <CDM.h> |
---|
|
Prototype: | CDM_Annotation CDM_FirstAnnotationContaining(CDM_Document Document, const long Position);
|
---|
Arguments: | Document: A Document object. (CDM_Document) Position: Position in text. (long)
|
---|
|
|
Prototype: | CDM_Annotation CDM_FirstAnnotationContaining(CDM_Document Document, const long Position1, const long Position2);
|
---|
Arguments: | Document: A Document object. (CDM_Document) Position1: Position in text. (long) Position2: Position in text. (long)
|
---|
|
|
Prototype: | CDM_Annotation CDM_FirstAnnotationContaining(CDM_AnnotationSet Set, const long Position);
|
---|
Arguments: | Set: Annotation Set object. (CDM_AnnotationSet) Position: Position in text. (long)
|
---|
|
|
Prototype: | CDM_Annotation CDM_FirstAnnotationContaining(CDM_AnnotationSet Set, const long Position1, const long Position2);
|
---|
Arguments: | Set: Annotation Set object. (CDM_AnnotationSet) Position1: Position in text. (long) Position2: Position in text. (long)
|
---|
|
|
Description:
This function will return a new Annotation object (of type
CDM_Annotation) that will be the first Annotation (with Annotations
sorted by their Id) of the
specified Document that includes the specified text position (as given
by the parameter "Position") into its spans. If no Annotation is found
that includes the specified position, NULL will be returned and
the empty object will be placed as a result in the current active
Tcl interpreter (CDM_Interp). The caller can use the function
CDM_ActiveInterpreterResultEmpty to check whether the
current active Tcl interpreter (CDM_Interp) has as result the empty
object. 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 object (of type
CDM_Annotation) that will be the first Annotation (with Annotations
sorted by their Id) of the
specified Document that include the two specified text positions
(as given by the parameters "Position1" and "Position2")
into its spans. If no Annotation is found
that includes the specified positions, NULL will be returned and
the empty object will be placed as a result in the current active
Tcl interpreter (CDM_Interp). The caller can use the function
CDM_ActiveInterpreterResultEmpty to check whether the
current active Tcl interpreter (CDM_Interp) has as result the empty
object. 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 object (of type
CDM_Annotation) that will be the first Annotation (with Annotations
sorted by their Id) of the
specified Annotation set that includes the specified text position
(as given by the parameter "Position") into its spans.
If no Annotation is found
that includes the specified position, NULL will be returned and
the empty object will be placed as a result in the current active
Tcl interpreter (CDM_Interp). The caller can use the function
CDM_ActiveInterpreterResultEmpty to check whether the
current active Tcl interpreter (CDM_Interp) has as result the empty
object. 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 object (of type
CDM_Annotation) that will be the first Annotation (with Annotations
sorted by their Id) of the
specified Document that include the two specified text positions
(as given by the parameters "Position1" and "Position2")
into ts spans. If no Annotation is found
that includes the specified positions, NULL will be returned and
the empty object will be placed as a result in the current active
Tcl interpreter (CDM_Interp). The caller can use the function
CDM_ActiveInterpreterResultEmpty to check whether the
current active Tcl interpreter (CDM_Interp) has as result the empty
object. 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 object (of type
CDM_Annotation). The returned object is owned by CDM. 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 object (of type
CDM_Annotation). The returned object is owned by CDM. 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 object (of type
CDM_Annotation). The returned object is owned by CDM. 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 object (of type
CDM_Annotation). The returned object is owned by CDM. 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_FirstAnnotationContaining (Tcl API). This function is equivelant to tip_FirstAnnotationContaining (Tcl API). This function is equivelant to tip_FirstAnnotationContaining (Tcl API). This function is equivelant to tip_FirstAnnotationContaining (Tcl API).
See Also:
CDM_FirstAnnotationAt, CDM_FirstAnnotationInRange, CDM_FirstAnnotationMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_FirstAnnotationContaining CDM_FirstAnnotationAt, CDM_FirstAnnotationInRange, CDM_FirstAnnotationMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_FirstAnnotationContaining CDM_FirstAnnotationAt, CDM_FirstAnnotationInRange, CDM_FirstAnnotationMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_FirstAnnotationContaining CDM_FirstAnnotationAt, CDM_FirstAnnotationInRange, CDM_FirstAnnotationMatchingRange,
CDM_Free, Tcl_DecrRefCount,
tip_FirstAnnotationContaining
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.