Function tip_SelectAnnotations


Prototype: tip_SelectAnnotations(Document);
Arguments:

Document: A Document object. (CDM_Document)
Type: The type of the Annotations to be selected. (string)


Prototype: tip_SelectAnnotations(Annotation);
Arguments:

Document: A Document object. (CDM_Document)
Type: The type of the Annotations to be selected. (string)

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

Description:

tip_SelectAnnotations(Document):
This function will create and return a new object (of type CDM_AnnotationSet) that will contain all the Annotations of the specified Document that their type is the same as the value of the "Type" parameter. This function will always create and return a new object, even when no Annotations of the requested type are found or when the Document has no Annotations defined. In this case an empty object will be returned.

tip_SelectAnnotations(Annotation):

Return Value:

tip_SelectAnnotations(Document):
This function will create and return an AnnotationSet object, that will contain all the Annotations of the specified Document that have as type the value of the "Type" parameter.

In case of an error, an error message will be prompted.

tip_SelectAnnotations(Annotation):

Notes:

tip_SelectAnnotations(Document):
This function is equivelant to CDM_SelectAnnotations (C++ API).

tip_SelectAnnotations(Annotation):

See Also:

tip_SelectAnnotations(Document):
tip_Free, Tcl_DecrRefCount

tip_SelectAnnotations(Annotation):


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