Function CDM_GetAttributes


Definition:#include <CDM.h>
Prototype:CDM_AttributeSet CDM_GetAttributes(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype:CDM_AttributeSet CDM_GetAttributes(CDM_Document Document);
Arguments:

Document: A Document object. (CDM_Document)


Prototype:CDM_AttributeSet CDM_GetAttributes(CDM_Annotation Annotation);
Arguments:

Annotation: An Annotation object (CDM_Annotation)

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

Description:

CDM_AttributeSet CDM_GetAttributes(CDM_Collection Collection):
This function returns a new object (of type CDM_AttributeSet) that contains all the Attributes that the specified Collection currently has. CDM does not own this object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

This function will always create and return a new Attribute set object, even when the Collection has no Attributes defined. (In this case an empty Attribute set will be returned.)

CDM_AttributeSet CDM_GetAttributes(CDM_Document Document):
This function returns a new object (of type CDM_AttributeSet) that contains all the Attributes that the specified Document currently has. CDM does not own this object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

This function will always create and return a new Attribute set object, even when the Document has no Attributes defined. (In this case an empty Attribute set will be returned...)

CDM_AttributeSet CDM_GetAttributes(CDM_Annotation Annotation):
This function returns a new object (of type CDM_AttributeSet) that contains all the Attributes that the specified Annotation currently has.

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 of CDM_Free must be used.

Return Value:

CDM_AttributeSet CDM_GetAttributes(CDM_Collection Collection):
This function returns an Attribute set object (of type CDM_AttributeSet). The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

CDM_AttributeSet CDM_GetAttributes(CDM_Document Document):
This function returns an Attribute set object (of type CDM_AttributeSet). The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

CDM_AttributeSet CDM_GetAttributes(CDM_Annotation Annotation):
This function returns an Attribute set object (of type CDM_AttributeSet), that contains all the Attribute objects held by the provided Annotation object.

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 of CDM_Free must be used.

Notes:

CDM_AttributeSet CDM_GetAttributes(CDM_Collection Collection):
This function is equivelant to tip_GetAttributes (Tcl API).

CDM_AttributeSet CDM_GetAttributes(CDM_Document Document):
This function is equivelant to tip_GetAttributes (Tcl API).

CDM_AttributeSet CDM_GetAttributes(CDM_Annotation Annotation):
This function is equivelant to tip_GetAttributes (Tcl API).

See Also:

CDM_AttributeSet CDM_GetAttributes(CDM_Collection Collection):
CDM_Free, Tcl_DecrRefCount, tip_GetAttributes

CDM_AttributeSet CDM_GetAttributes(CDM_Document Document):
CDM_Free, Tcl_DecrRefCount, tip_GetAttributes

CDM_AttributeSet CDM_GetAttributes(CDM_Annotation Annotation):
CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount, tip_GetAttributes


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