Function CDM_Status


Definition:#include <CDM.h>
Prototype:CDM_ByteSequence CDM_Status(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype:CDM_ByteSequence CDM_Status(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:

CDM_ByteSequence CDM_Status(CDM_Collection Collection):
This function will return information about the specified Collection. This information will be stored as text in a newly created Tcl object. 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.

This function will always create and return a new Tcl string object. In case of an error, NULL will be returned.

CDM_ByteSequence CDM_Status(CDM_Document Document):
This function will return information about the specified Document. This information will be stored as text in a newly created Tcl object. 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.

This function will always create and return a new Tcl string object. In case of an error, NULL will be returned.

Return Value:

CDM_ByteSequence CDM_Status(CDM_Collection Collection):
This function returns a Tcl string object (of type Tcl_Obj *), containing the information of the specified Collection. The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

CDM_ByteSequence CDM_Status(CDM_Document Document):
This function returns a Tcl string object (of type Tcl_Obj *), containing the information of the specified Document. The caller is responsible to free this object through Tcl_DecrRefCount or CDM_Free.

See Also:

CDM_ByteSequence CDM_Status(CDM_Collection Collection):
CDM_Free, Tcl_DecrRefCount

CDM_ByteSequence CDM_Status(CDM_Document Document):
CDM_Free, Tcl_DecrRefCount


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