Function CDM_AddAnnotationSpan


Definition:#include <CDM.h>
Prototype:CDM_Annotation CDM_AddAnnotationSpan(CDM_Annotation Annotation, CDM_Span span);
Arguments:

Ann: An Annotation object. (CDM_Annotation)
span: The Span object that should be added in the set of spans held by the specifiied Annotation object. (CDM_Span)
end: The end byte offset of the Span to be deleted. (long)

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

Description:

This function will add the provided Span object (of type CDM_Span) in the Span Set object held internally by the Annotation object. The returned value of this function will always be a new Annotation object with the provided Span object added. In the case of an error NULL will be returned and an error will be left at the current active Tcl interpreter (CDM_Interp).

Return Value:

This function returns a new Annotation object (of type CDM_Annotation). In case of an error NULL will be returned and an error will be left at the current active Tcl interpreter (CDM_Interp).

Note that the returned Annotation object (if not NULL and not the same as the original Annotation object) is not property of CDM and the caller is responsible to free this object when it is no longer needed by either calling Tcl_DecrRefCount or CDM_Free.

Notes:

This function is equivelant to tip_AddSpan (Tcl API).

See Also:

Tcl_DecrRefCount, CDM_RemoveSpan, tip_AddSpan


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