Function tip_RemoveSpan


Prototype: tip_RemoveSpan(Annotation);
Arguments:

Ann: An Annotation object. (CDM_Annotation)
start: The start byte offset of the Span to be deleted. (long)
end: The end byte offset of the Span to be deleted. (long)

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

Description:

This function will remove the Span having as start and end offsets the values specified through the "start" and "end" parameters from the specified Annotation, if such a Span object exists. The returned value of this function will always be a new Annotation object if a proper Span object was found and removed. If a Span object with the proper start and end offsets was not found, the empty string will be returned.

Return Value:

This function returns a new Annotation object (of type CDM_Annotation) if a Span object with the same offsets as the provided ones is found and removed from the provided Annotation. In the case that a proper Span object is not found, the empty string ({}) is returned.

Notes:

This function is equivelant to CDM_RemoveSpan (C++ API).

See Also:

CDM_RemoveSpan


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