Function CDM_GetAnnotationAttributeNames


Definition:#include <CDM.h>
Prototype:Tcl_Obj * CDM_GetAnnotationAttributeNames(CDM_Document Document, Tcl_Obj *Type);
Arguments:

Document: A Document object. (CDM_Document)
Type: The type of the Annotations to be searched. (Tcl_Obj *)

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

Description:

This function will search all Annotations of the specified Document, that their type corresponds to the value of the "Type" parameter, and will return a new object (of type Tcl_Obj *) that will contain all the Attribute names found in the Annotation Attribute sets.

CDM does not own this object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

Note that this function will always create and return a new object, even when the Document has no Annotations defined. (In this case an empty object will be returned.)

Return Value:

This function returns a Tcl list object (of type Tcl_Obj *). The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

Notes:

This function does not have an equivelant in the Tcl API. In order for this function to be accessed from the Tcl API, the user must call the method "GetAnnotationAttributeNames" of a Document object. For example, if "Doc0" is a Tcl Document object returned by the CDM to the user, the user must use the following code:

Doc0 GetAnnotationAttributeNames

Note that this functionality does not exist under the GATE NLP Platform.

See Also:

CDM_Free, Tcl_DecrRefCount


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