Function CDM_SetComment


Definition:#include <CDM.h>
Prototype:int CDM_SetComment(CDM_Collection Collection, Tcl_Obj *Info);
Arguments:

Collection: A Collection object. (CDM_Collection)
Info: A Tcl object holding the information that is to be associated as comment with the specified Collection (Tcl_Obj *)

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

Description:

This function sets the provided Tcl object (of type Tcl_Obj*) as comment to the specified Collection object. This "comment" (Tcl object) can contain anything that the user wants to store with this Collection. CDM does not modify or use this information in any way. This comment object will be saved allong the Collection, if the Collection is saved. This is the primary difference of comment towards associated information that can be inserted with CDM_GetAssociatedInfo/CDM_SetAssociatedInfo.

Return Value:

The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If the requested Collection exists and the comment Tcl object is successfully associated with the Collection, then TCL_OK will be returned. In case of an error, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_GetComment (Tcl API).

See Also:

CDM_GetComment, CDM_GetAssociatedInfo, CDM_SetAssociatedInfo, CDM_Free, Tcl_DecrRefCount, Tcl_IncrRefCount


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