Function CDM_GetFirstSpan


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

Annotation: The Annotation object. (CDM_Annotation)

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

Description:

This function will return the first span range of the span list contained in the specified Annotation. Note that the returned object is owned by the CDM. The caller is not supposed to free or modify the returned object.

Return Value:

This function returns a Span object (of type CDM_Span).

If an error occurs, then NULL will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Note that the returned object is property of the CDM and should never be freed or modified in any way by the caller.

Notes:

This function is equivelant to the following C++ code:
CDM_Nth(CDM_GetSpans(CDM_Annotation ann), 0);
This function is also equivelant to tip_GetFirstSpan (Tcl API).

See Also:

CDM_GetSpans, CDM_Nth, tip_GetFirstSpan


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