Function tip_GetFirstAnnotation


Prototype: tip_GetFirstAnnotation(Document);
Arguments:

Document: A Document object. (CDM_Document)
Type: The type of the desired Annotations. (string)

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

Description:

This function will start an iteration over the Annotations of the specified type that the specified Document has. This function will return the first Annotation object that has as type the value specified by the "Type" parameter. If the requested Annotation does not exist, an error will be prmpted. Subsequent calls to tip_GetNextAnnotation will return the rest of the Annotations of the same type, sorted according to their Id.

Return Value:

This function returns an Annotation object (of type CDM_Annotation) if an Annotation having as type the value of the "Type" parameter is found. In case that the specified Annotation does not exist, an error message will be prompted.

Notes:

This function is equivelant to CDM_GetFirstAnnotation (C++ API).

See Also:

tip_GetNextAnnotation, tip_Free, Tcl_IncrRefCount, Tcl_DecrRefCount


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