Function CDM_GetFirstSpanOffsets


Definition:#include <CDM.h>
Prototype:int CDM_GetFirstSpanOffsets(CDM_Annotation Annotation, long *start, long *end);
Arguments:

Annotation: An Annotation object (CDM_Annotation)
start: A pointer pointing to a long, where the start value of the specified span will be placed. (long *)
end: A pointer pointing to a long, where the end value of the specified span will be placed. (long *)

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

Description:

This function will place the values of both span start and end of the Annotation's first span in the two specified long integer pointers. Each span object is a set of exactly two integers, named as "start" and "end".

Return Value:

This function will place the two Offsets contained in the first span object of the provided Annotation (the start and end of the span) into the two long variables pointed by the two provided pointers.

The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If an error occurs, the return value will be TCL_ERROR and an error message describing the error will be placed at the current Tcl interpreter (CDM_Interp). Else, TCL_OK will be returned.

Notes:

This function is equivelant to the following C++ code:
span = CDM_GetFirstSpan(Annotation);
*start = CDM_GetStart(span);
*end = CDM_GetEnd(Span);
This function is equivelant to tip_GetFirstSpanOffsets (Tcl API).

See Also:

CDM_GetFirstSpan, CDM_GetStart, CDM_GetEnd, tip_GetFirstSpanOffsets


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