Function CDM_GetFirstAnnotatedTextRange


Definition:#include <CDM.h>
Prototype:CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_Document Document, CDM_Annotation Annotation);
Arguments:

Document: A Document object. (CDM_Document)
Annotation: The Annotation that indexes the text range. (CDM_Annotation)


Prototype:CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_ByteSequence Text, CDM_Annotation Annotation);
Arguments:

Text: The text object indexed by the Annotation. (CDM_ByteSequence)
Annotation: The Annotation that indexes the text range. (CDM_Annotation)

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

Description:

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_Document Document, CDM_Annotation Annotation):
This function will return a the text range from the text of the specified Document object that is annotated by the first span of the provided Annotation. In simple words, this function will retrieve the first span from the provided Annotation and return the text range (from the text of the specified Document object) that is indexed by this span.

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.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_ByteSequence Text, CDM_Annotation Annotation):
This function will return a the text range from the provided Text object that is annotated by the first span of the provided Annotation. In simple words, this function will retrieve the first span from the provided Annotation and return the text range (from the specified text object) that is indexed by this span.

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.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

Return Value:

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_Document Document, CDM_Annotation Annotation):
This function returns a ByteSequence/RawData object (of type CDM_ByteSequence or CDM_RawData) containing the text range (or portion) from the text contained in the "Document" object indexed by the first span of the "Annotation" parameter.

Note that 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.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. In this case an empty object (i.e. one containing the string "") will be returned.)

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_ByteSequence Text, CDM_Annotation Annotation):
This function returns a ByteSequence/RawData object (of type CDM_ByteSequence or CDM_RawData) containing the text range (or portion) from the "Text" object indexed by the first span of the "Annotation" parameter.

Note that 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.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. In this case an empty object (i.e. one containing the string "") will be returned.)

Notes:

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_Document Document, CDM_Annotation Annotation):
This function is equivelant to tip_GetFirstAnnotatedTextRange (Tcl API).

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_ByteSequence Text, CDM_Annotation Annotation):
Note that usually the provided text object is the text of a Document, retrieved through calls to either CDM_GetByteSequence or CDM_GetRawData. The text object is expected to contain text in Unicode or UTF-8 representation.

This function is equivelant to tip_GetFirstAnnotatedTextRange (Tcl API).

See Also:

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_Document Document, CDM_Annotation Annotation):
CDM_GetByteSequence, CDM_GetRawData, Tcl_DecrRefCount, CDM_Free, CDM_GetAnnotatedTextRanges, tip_GetFirstAnnotatedTextRange

CDM_ByteSequence CDM_GetFirstAnnotatedTextRange(CDM_ByteSequence Text, CDM_Annotation Annotation):
CDM_GetByteSequence, CDM_GetRawData, Tcl_DecrRefCount, CDM_Free, CDM_GetAnnotatedTextRanges, tip_GetFirstAnnotatedTextRange


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