Function CDM_GetAnnotation


Definition:#include <CDM.h>
Prototype:CDM_Annotation CDM_GetAnnotation(CDM_Document Document, long Id);
Arguments:

Document: A Document object. (CDM_Document)
Id: The Id of the desired Annotation. (long)


Prototype:CDM_Annotation CDM_GetAnnotation(CDM_Document Document, Tcl_Obj *Id);
Arguments:

Document: A Document object. (CDM_Document)
Id: A Tcl object containing the Id of the desired Annotation. (Tcl_Obj *)


Prototype:CDM_Annotation CDM_GetAnnotation(CDM_AnnotationSet Set, long Id);
Arguments:

Set: Annotation Set. (CDM_AnnotationSet)
Id: Annotation's Id. (long)

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

Description:

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, long Id):
This function will return the Annotation object that has as Id the value specified by the "Id" parameter. If the requested Annotation does not exist, an error will be returned.

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, Tcl_Obj *Id):
This function will return the Annotation object that has as Id the value specified by the "Id" parameter. If the requested Annotation does not exist, an error will be returned.

CDM_Annotation CDM_GetAnnotation(CDM_AnnotationSet Set, long Id):
This function will return the Annotation object that has as Id the value specified by the "Id" parameter. If the requested Annotation does not exist, an error will be returned.

Note that this function will also return an error if an Annotation object is encoutered that does not have an Id (as Annotation objects with empty Ids are permitted inside Annotation set objects).

Return Value:

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, long Id):
This function returns an Annotation object (of type CDM_Annotation) if an Annotation having as Id the value of the "Id" parameter is found. In case that the specified Annotation does not exist, NULL is returned. 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) after he has placed a request with Tcl_IncrRefCount, the functions Tcl_DecrRefCount or CDM_Free must be used.

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, Tcl_Obj *Id):
This function returns an Annotation object (of type CDM_Annotation) if an Annotation having as Id the value of the "Id" parameter is found. In case that the specified Annotation does not exist, or the Tcl object (specified by the "Id" parameter) does not contain a long integer value, NULL is returned. 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) after he has placed a request with Tcl_IncrRefCount, the functions Tcl_DecrRefCount or CDM_Free must be used.

CDM_Annotation CDM_GetAnnotation(CDM_AnnotationSet Set, long Id):
This function returns an Annotation object (of type CDM_Annotation) if an Annotation having as Id the value of the "Id" parameter is found. In case that the specified Annotation does not exist or an Annotation with an empty Id is found, NULL is returned. 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) after he has placed a request with Tcl_IncrRefCount, the functions Tcl_DecrRefCount or CDM_Free must be used.

Notes:

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, long Id):
This function is equivelant to tip_GetAnnotation (Tcl API).

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, Tcl_Obj *Id):
This function is equivelant to tip_GetAnnotation (Tcl API).

CDM_Annotation CDM_GetAnnotation(CDM_AnnotationSet Set, long Id):
This function is equivelant to tip_GetAnnotation (Tcl API).

See Also:

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, long Id):
CDM_Free, Tcl_IncrRefCount, Tcl_DecrRefCount, tip_GetAnnotation

CDM_Annotation CDM_GetAnnotation(CDM_Document Document, Tcl_Obj *Id):
CDM_Free, Tcl_IncrRefCount, Tcl_DecrRefCount, tip_GetAnnotation

CDM_Annotation CDM_GetAnnotation(CDM_AnnotationSet Set, long Id):
CDM_Free, Tcl_IncrRefCount, Tcl_DecrRefCount, tip_GetAnnotation


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