Function CDM_GetValueValue


Definition:#include <CDM.h>
Prototype:CDM_AttributeValue CDM_GetValueValue(CDM_Attribute Attribute);
Arguments:

Attribute: The Attribute object whose value is wanted. (CDM_Attribute)

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

Description:

This function will return the value of the Attribute value of the specified Attribute. An Attribute value consists of two elements: the type of the information stored as Attribute value (for example GDM_STRING or GDM_STRING_SET) and the information that is stored as a value of the Attribute. This function returns the latter object. This function is different from CDM_GetValue, as CDM_GetValue returns a list object that holds two elements, the value type and the value. On the other hand, CDM_GetValueValue returns directly the value, by ommiting the object specifying the type. If the caller wants to also get the type of the value, he can either call CDM_GetValue or CDM_GetValueType.

Return Value:

This function returns the object that holds the value stored in an Attribute object. The returned object is property of the Attribute and should not be modified or freed. If the caller wants to keep a reference to the returned object, he must place such a request by using Tcl_IncrRefCount. When the returned object is not needed any more and the caller wants to release the object, the functions Tcl_DecrRefCount or CDM_Free must be used.

Notes:

This function is equivelant to tip_GetValueValue (Tcl API).

See Also:

CDM_GetValue, CDM_GetValueValue, CDM_Free, tip_GetValueValue, Tcl_IncrRefCount, Tcl_DecrRefCount


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