Function CDM_GetType


Definition:#include <CDM.h>
Prototype:char * CDM_GetType(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.

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

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 string (of type char *), 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 value.

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 CDM_StrCpy or equivalent.

This function is equivelant to tip_GetType (Tcl API).

See Also:

CDM_GetTypeObj, CDM_StrCpy, tip_GetType


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