Definition: | #include <CDM.h> |
---|
|
Prototype: | char * CDM_SetEncoding(CDM_Collection Collection, char *Encoding);
|
---|
Arguments: | Collection: A Collection object. (CDM_Collection) Encoding: The desired new encoding of the Collection. (char *)
|
---|
|
|
Prototype: | char * CDM_SetEncoding(CDM_Document Document, char *Encoding);
|
---|
Arguments: | Document: A Document object. (CDM_Document) Encoding: The desired new encoding of the Document. (char *)
|
---|
|
|
Description:
This function will change the encoding of a Collection object to the
encoding specified by the "Encoding" parameter.char * CDM_SetEncoding(CDM_Document Document, char *Encoding): |
This function will change the encoding of a Document object to the
encoding specified by the "Encoding" parameter.
Return Value:
This function will return a pointer (of type char*) to the string
buffer that holds the new encoding value. This pointer will be at a
different memory location than the given parameter value, as the CDM
will create and manipulate a local copy. In case of an error, NULL will be returned and an error message
describing the error will be left at the current Tcl
interpreter (CDM_Interp).
Note that the returned pointer is property of the CDM and should never
be freed or modified in any way by the caller.
char * CDM_SetEncoding(CDM_Document Document, char *Encoding): |
This function will return a pointer (of type char*) to the string
buffer that holds the new encoding value. This pointer will be at a
different memory location than the given parameter value, as the CDM
will create and manipulate a local copy. In case of an error, NULL will be returned and an error message
describing the error will be left at the current Tcl
interpreter (CDM_Interp).
Note that the returned pointer 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_SetEncoding (Tcl API).char * CDM_SetEncoding(CDM_Document Document, char *Encoding): |
This function is equivelant to tip_SetEncoding (Tcl API).
See Also:
CDM_GetEncoding, tip_SetEncodingchar * CDM_SetEncoding(CDM_Document Document, char *Encoding): |
CDM_GetEncoding, tip_SetEncoding
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.