Function CDM_Length


Definition:#include <CDM.h>
Prototype:int CDM_Length(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype:int CDM_Length(Tcl_Obj *Set);
Arguments:

Set: The set object. (CDM_AnnotationSet or CDM_AttributeSet or CDM_SpanSet or Tcl_Obj *)

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

Description:

int CDM_Length(CDM_Collection Collection):
This function will return the Length (the number of all the Documents) of the specified Collection.

int CDM_Length(Tcl_Obj *Set):
This function will return the number of elements contained in a set of objects. This set can be any CDM set object (for example any object of type CDM_AnnotationSet, CDM_AttributeSet or CDM_SpanSet) or a Tcl list object (of type Tcl_Obj *),

Return Value:

int CDM_Length(CDM_Collection Collection):
This function will return an integer value that will represent the total number of the Documents that the specified Collection currently holds.

If an error occurs, then a negative value (-1) will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

int CDM_Length(Tcl_Obj *Set):
This function returns an integer representing the number of objects contained in the provided set object. If the provided set is empty, 0 will be returned. In case of an error (i.e. the provided set object is not a valid set object), -1 is returned and an error will be reported in the current Tcl interpreter (CDM_Interp).

Notes:

int CDM_Length(CDM_Collection Collection):
This function is equivelant to tip_GetLength (Tcl API).

int CDM_Length(Tcl_Obj *Set):
This function is equivelant to the "llength" Tcl command.

See Also:

int CDM_Length(CDM_Collection Collection):
tip_GetLength

int CDM_Length(Tcl_Obj *Set):
tip_GetLength


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