Function CDM_SetByteSequence


Definition:#include <CDM.h>
Prototype:int CDM_SetByteSequence(CDM_Document Document, CDM_ByteSequence Text);
Arguments:

Document: A Document object. (CDM_Document)
Text: The desired new text object. (CDM_ByteSequence)

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

Description:

This function will change the text of a Document object to the text specified by the "Text" parameter. The "Text" parameter must be an object of type CDM_ByteSequence. Such an object can be created with Tcl_NewStringObj. The text that this function accepts, is asumend to be encoding according to the UTF-8 encoding. If the text is stored using a different encoding, the caller must use CDM_ExternalToUtf in order to convert the text to UTF. CDM will internally keep a reference to this object.

Return Value:

The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If an error occurs, 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_SetByteSequence (Tcl API).

See Also:

CDM_ExternalToUtf, CDM_SetRawData, Tcl_NewStringObj, CDM_ExternalToUtf, tip_SetByteSequence


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