Function CDM_GetComment


Definition:#include <CDM.h>
Prototype:Tcl_Obj * CDM_GetComment(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)

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

Description:

This function returns the Tcl object (of type Tcl_Obj*) holding a comment associated to this this Collection object.

Return Value:

This function returns a Tcl object (of type Tcl_Obj*) if a comment has already been associated with this Collection object. Otherwise, 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:

This function is equivelant to tip_GetComment (Tcl API).

See Also:

CDM_SetComment, CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount


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