Function CDM_GetEncoding


Definition:#include <CDM.h>
Prototype:char * CDM_GetEncoding(CDM_Collection Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)


Prototype:char * CDM_GetEncoding(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:

char * CDM_GetEncoding(CDM_Collection Collection):
This function will return the encoding of the specified Collection. The return value will be of type char* and will be owned by CDM. Its value will be a standart Tcl encoding value (like iso8859-7 or cp1253). For all available Tcl encodings please refer to the Tcl manuals.

char * CDM_GetEncoding(CDM_Document Document):
This function will return the encoding of the specified Document. The return value will be of type char* and will be owned by CDM. Its value will be a standart Tcl encoding value (like iso8859-7 or cp1253). For all available Tcl encodings please refer to the Tcl manuals.

Return Value:

char * CDM_GetEncoding(CDM_Collection Collection):
This function returns a UTF-8 string that represents the encoding of the specified Collection.

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.

char * CDM_GetEncoding(CDM_Document Document):
This function returns a UTF-8 string that represents the encoding 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 memory segment is property of the CDM and should never be freed or modified in any way by the caller.

Notes:

char * CDM_GetEncoding(CDM_Collection Collection):
This function is equivelant to tip_GetEncoding (Tcl API).

char * CDM_GetEncoding(CDM_Document Document):
This function is equivelant to tip_GetEncoding (Tcl API).

See Also:

char * CDM_GetEncoding(CDM_Collection Collection):
CDM_SetEncoding, tip_GetEncoding, The Tcl Encoding manual.

char * CDM_GetEncoding(CDM_Document Document):
CDM_SetEncoding, tip_GetEncoding, The Tcl Encoding manual.


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