Function CDM_AddAttribute


Definition:#include <CDM.h>
Prototype:CDM_AttributeSet CDM_AddAttribute(CDM_AttributeSet AttributeSet, CDM_Attribute Attribute);
Arguments:

AttributeSet: Attribute set where the Attribute will be appended. (CDM_AttributeSet)
Attribute: Attribute to be appended (CDM_Attribute)

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

Description:

This function will append the given Attribute (the value of the "Attribute" parameter) to the specified Attribute set (by the value of the "AttributeSet" parameter). A reference to the Attribute will be added by the AttributeSet, so after this call the Attribute object may be converted to a shared object.

The Attribute set specified by the "AttributeSet" parameter will be modified only if it is not a shared object. If it is a shared object, a new (duplicate) object will be created and the new Attribute will be appended to this new object. If a new Attribute set is created, the initial one will be not modified in any way. In all cases, a reference to the Attribute set that additionally contains the new Attribute will be returned.

Return Value:

This function will return an Annotation set object (of type CDM_AnnotationSet) that will contain all Annotations (including the new one). This Annotation set may not be the original Annotation set that was specified through the "AnnotationSet" parameter.

In case of an error, NULL will be returned and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_AddAttribute (Tcl API).

See Also:

Tcl_IsShared, tip_AddAttribute


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