Function CDM_GetAttribute


Definition:#include <CDM.h>
Prototype:CDM_Attribute CDM_GetAttribute(CDM_Collection Collection, char *Name);
Arguments:

Collection: A Collection object. (CDM_Collection)
Name: Attribute name. (char *)


Prototype:CDM_Attribute CDM_GetAttribute(CDM_Document Document, char *Name);
Arguments:

Document: A Document object. (CDM_Document)
Name: Attribute name (char *)


Prototype:CDM_Attribute CDM_GetAttribute(CDM_Annotation Annotation, char *Name);
Arguments:

Annotation: The Annotation to be searched (CDM_Annotation)
Name: The Attribute's Name (char *)

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

Description:

CDM_Attribute CDM_GetAttribute(CDM_Collection Collection, char *Name):
This function will search all the Attributes that the specified Collection has, for an Attribute that has the same name as the "Name" parameter. If such an Attribute is found, the Attribute object is return. If an Attribute with the specified name does not exist, NULL is returned.

CDM_Attribute CDM_GetAttribute(CDM_Document Document, char *Name):
This function will search all the Attributes that the specified Document has, for an Attribute that has the same name as the "Name" parameter. If such an Attribute is found, the Attribute object is return. If an Attribute with the specified name does not exist, NULL is returned.

CDM_Attribute CDM_GetAttribute(CDM_Annotation Annotation, char *Name):
This function will search all the Attributes that the specified Annotation object has, for an Attribute that has the same name as the "Name" parameter. If such an Attribute is found, the Attribute object is return. If an Attribute with the specified name does not exist, NULL is returned.

Return Value:

CDM_Attribute CDM_GetAttribute(CDM_Collection Collection, char *Name):
This function returns an Attribute object (of type CDM_Attribute) if an Attribute named as specified is found. In case that the specified Attribute 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), the functions Tcl_DecrRefCount of CDM_Free must be used.

CDM_Attribute CDM_GetAttribute(CDM_Document Document, char *Name):
This function returns an Attribute object (of type CDM_Attribute) if an Attribute named as specified is found. In case that the specified Attribute 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), the functions Tcl_DecrRefCount of CDM_Free must be used.

CDM_Attribute CDM_GetAttribute(CDM_Annotation Annotation, char *Name):
This function returns an Attribute object (of type CDM_Attribute) if an Attribute named as specified is found. In case that the specified Attribute 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), the functions Tcl_DecrRefCount of CDM_Free must be used.

Notes:

CDM_Attribute CDM_GetAttribute(CDM_Collection Collection, char *Name):
This function is equivelant to tip_GetAttribute (Tcl API).

CDM_Attribute CDM_GetAttribute(CDM_Document Document, char *Name):
This function is equivelant to tip_GetAttribute (Tcl API).

CDM_Attribute CDM_GetAttribute(CDM_Annotation Annotation, char *Name):
This function is equivelant to tip_GetAttribute (Tcl API).

See Also:

CDM_Attribute CDM_GetAttribute(CDM_Collection Collection, char *Name):
CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount, tip_GetAttribute

CDM_Attribute CDM_GetAttribute(CDM_Document Document, char *Name):
CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount, tip_GetAttribute

CDM_Attribute CDM_GetAttribute(CDM_Annotation Annotation, char *Name):
CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount, tip_GetAttribute


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