Function CDM_GetTypeObj


Definition:#include <CDM.h>
Prototype:CDM_ByteSequence CDM_GetTypeObj(CDM_Annotation Annotation);
Arguments:

Annotation: The Annotation whose type is to be returned. (CDM_Annotation)

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

Description:

This function returns the type of the specified Annotation object. The returned value will be encoded using the UTF-8 encoding, as a valid object of type CDM_ByteSequence.

The return value will be of type CDM_ByteSequence and will be owned by CDM. As a result the user must not free or modify the returned object.

Note that the return value will be invalidated if the user either destroy the Annotation or change its type.

Return Value:

The return value of this function will be a text object (of type CDM_ByteSequence or equivalently CDM_RawData), representing the type of the specified Annotation object. In case of an error, NULL will be returned and an error will be left at the current active interpreter (CDM_Interp).

Note that the returned value is owned by CDM: the user must not modify the contents or free the returned object.

Notes:

Note that the return value will be invalidated if the user either destroy the Annotation or change its type. If this value has to be kept for prolonged period of time, the caller should create a copy of the returned value with Tcl_DuplicateObj.

This function is equivelant to tip_GetTypeObj (Tcl API).

See Also:

CDM_GetType, Tcl_DuplicateObj, tip_GetTypeObj


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