Function CDM_GetParent


Definition:#include <CDM.h>
Prototype:CDM_Collection CDM_GetParent(CDM_Document Document);
Arguments:

Document: A Document object. (CDM_Document)

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

Description:

This function will return the parent of the specified Document. The parent of a Document is the Collection object that holds the specified Document. The return value will be the parent Collection object (of type CDM_Collection) and will be owned by CDM.

Return Value:

This function will return the Collection object that contains the specified Document.

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

Note that the returned object is property of the CDM and should never be freed or modified in any way by the caller.

Notes:

This function is equivelant to tip_GetParent (Tcl API).

See Also:

tip_GetParent


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