Function CDM_GetId


Definition:#include <CDM.h>
Prototype:char * CDM_GetId(CDM_Document Document);
Arguments:

Document: A Document object. (CDM_Document)


Prototype:long CDM_GetId(CDM_Annotation Annotation);
Arguments:

Ann: The Annotation whose Id is to be returned (CDM_Annotation)

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

Description:

char * CDM_GetId(CDM_Document Document):
This function will return the Id of the specified Document. The Id is the file name of the initial file that contained the text which was used in order to create the specified Document. The returned value will be encoded using the UTF-8 encoding (thus enabling the existance of non Latin characters in the value).

The return value will be of type char* and will be owned by CDM.

long CDM_GetId(CDM_Annotation Annotation):
This function will return the Id of the specified Annotation. The Id of an Annotation is a unique integer (of type long) that unambigiously specifies an Annotation object inside a Document. CDM ensures that each Annotation of the Annotations contained in a Document will have a unique Id.

Return Value:

char * CDM_GetId(CDM_Document Document):
This function returns a UTF-8 string that represents the Id of the specified Document.

If an error occurs, then NULL will be return 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.

long CDM_GetId(CDM_Annotation Annotation):
This function returns an integer (of type long) that is the Id of the specified Annotation object.

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

Notes:

char * CDM_GetId(CDM_Document Document):
This function is equivelant to tip_GetId (Tcl API).

long CDM_GetId(CDM_Annotation Annotation):
This function is equivelant to tip_GetId (Tcl API).

See Also:

char * CDM_GetId(CDM_Document Document):
tip_GetId

long CDM_GetId(CDM_Annotation Annotation):
CDM_GetType, tip_GetId


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