Function CDM_CreateAttributeSet


Definition:#include <CDM.h>
Prototype:CDM_AttributeSet CDM_CreateAttributeSet(void);
Arguments:

None: (void)


Prototype:CDM_AttributeSet CDM_CreateAttributeSet(char *Name, CDM_AttributeValue Value);
Arguments:

Name: Attribute's Name (char *)
Value: Attribute's Value (CDM_AttributeValue)

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

Description:

CDM_AttributeSet CDM_CreateAttributeSet(void):
This function will create and return an empty Attribute set object (of type CDM_AttributeSet). CDM does not own the returned object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

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

CDM_AttributeSet CDM_CreateAttributeSet(char *Name, CDM_AttributeValue Value):
This function will create and return a new Attribute set object (of type CDM_AttributeSet) that will contain a newly created Attribute object, created according to the values specified as parameters. Note that this function is equivelant to creating an empty Attribute set object with CDM_CreateAttributeSet (void), creating a new Attribute object with CDM_CreateAttribute (char *Name, CDM_AttributeValue Value) and adding this Attribute object to the newly created Annotation set. Also note that the object specified through the "Value" parameter may be freed. For more details, please refer to the CDM_CreateAttribute documentation. CDM does not own the returned object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

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

Return Value:

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

If an error occurs, then NULL will be returned and an error message will be left at the current active Tcl interpreter (CDM_Interp).

CDM_AttributeSet CDM_CreateAttributeSet(char *Name, CDM_AttributeValue Value):
This function returns a new Attribute set object (of type CDM_AttributeSet) that will contain a newly created Attribute object, created according to the values specified as parameters. The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

If an error occurs, then NULL will be returned and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Notes:

CDM_AttributeSet CDM_CreateAttributeSet(void):
This function is equivelant to tip_CreateAttributeSet (Tcl API).

CDM_AttributeSet CDM_CreateAttributeSet(char *Name, CDM_AttributeValue Value):
Note that the object specified by the "Value" parameter will be freed, if it has a reference count equal to 0. For more details, please refer to the CDM_CreateAttribute documentation.

This function is equivelant to tip_CreateAttributeSet (Tcl API).

See Also:

CDM_AttributeSet CDM_CreateAttributeSet(void):
CDM_Free, Tcl_DecrRefCount, tip_CreateAttributeSet

CDM_AttributeSet CDM_CreateAttributeSet(char *Name, CDM_AttributeValue Value):
CDM_Free, Tcl_DecrRefCount, CDM_CreateAttribute, tip_CreateAttributeSet


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