Function CDM_SetExternalId


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

Document: A Document object. (CDM_Document)
ExternalId: The desired new external Id of the Document. (char *)

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

Description:

This function will modify 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 value is expected to be encoded using the UTF-8 encoding (thus enabling the existance of non Latin characters in the value). The caller can use the function CDM_ExternalToUft in order to convert a string from any supported encoding to UTF.

Return Value:

If the external Id of the specified Document is successfully updated, TCL_OK will be returned. In case of an error, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_SetEncoding (Tcl API).

See Also:

CDM_GetExternalId, CDM_SetExternalId, tip_SetExternalId


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