Function CDM_GetNextAnnotation
|
|
|
|
Description:
This function will return the next Annotation of the iteration started
with a call to CDM_GetFirstAnnotation, or of the Annotation returned by
a previous call to CDM_GetNextAnnotation. If no more Annotations of the
same type (which was specified through a call to CDM_GetFirstAnnotation)
exist in the specified Document, NULL will be returned. NULL will
also be returned if an error occurs.
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
CDM_GetFirstAnnotation exists in the specified Document.
In case that such an Annotation does not exist, NULL will be returned.
If NULL is returned, this function cannot be called unless
CDM_GetFirstDocument is called again, in order to initialise a new
iteration over Annotations of a specific type. Note that the returned object is property of the CDM and should never be
freed or directly modified in any way by the caller. Subsequent calls of
either the C++ or Tcl API can modify the returned object. If the caller
wants to keep a reference to the current state of the returned object,
he must place such a request by using Tcl_IncrRefCount. When the caller
wants to release the object (and return it to CDM), the functions
Tcl_DecrRefCount or CDM_Free must be used.
Notes:
This function is equivelant to tip_GetNextAnnotation (Tcl API).
See Also:
CDM_GetFirstAnnotation, CDM_Free,
Tcl_IncrRefCount, Tcl_DecrRefCount, tip_GetNextAnnotation
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.