Function CDM_GetExternalId


Definition:#include <CDM.h>
Prototype:char * CDM_GetExternalId(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 external Id (XID) of the specified Document. The external Id is the (absolute) path 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.

Return Value:

This function returns a UTF-8 string that represents the external 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.

Notes:

This function is equivelant to tip_GetExternalId (Tcl API).

See Also:

tip_GetExternalId


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