Function CDM_GetStart


Definition:#include <CDM.h>
Prototype:long CDM_GetStart(CDM_Span Span);
Arguments:

Span: Span (CDM_Span)

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

Description:

This function accepts a span (of type CDM_Span) and returns the start of this span. Each span object is a set of exactly two integers, named as "start" and "end".

Return Value:

This function returns the start value of the provided span object. If the provided object is not a valid span object or some other error occurs, CDM_GetStart will return -1 and an error message describing the error will be placed at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_GetStart (Tcl API).

See Also:

CDM_CreateSpan, CDM_GetEnd, tip_GetStart


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