Function tip_GetNextAnnotation


Prototype: tip_GetNextAnnotation(Document);
Arguments:

Document: A Document object. (CDM_Document)

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

Description:

This function will return the next Annotation of the iteration started with a call to tip_GetFirstAnnotation, or of the Annotation returned by a previous call to tip_GetNextAnnotation. If no more Annotations of the same type (which was specified through a call to tip_GetFirstAnnotation) exist in the specified Document, an error message will be prompted.

Return Value:

This function returns an Annotation object (of type CDM_Annotation) if an Annotation having as type the value specified by a prevous call to tip_GetFirstAnnotation exists in the specified Document. In case that such an Annotation does not exist, An error message will be prmpted. If that happens, this function cannot be called unless tip_GetFirstDocument is called again, in order to initialise a new iteration over Annotations of a specific type.

Notes:

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

See Also:

tip_GetFirstAnnotation, tip_Free, Tcl_IncrRefCount, Tcl_DecrRefCount


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