Function CDM_GetRange


Definition:#include <CDM.h>
Prototype:CDM_ByteSequence CDM_GetRange(CDM_ByteSequence textObj, long start, long end);
Arguments:

textObj: A text object. (CDM_ByteSequence or CDM_RawData)
start: An index to the first character to be extracted. (long)
end: An index to the last character to be extracted. (long)

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

Description:

This function will return a newly created object (of type CDM_ByteSequence or CDM_RawData) comprised of the characters between start and end (inclusive).

This function will always create and return a new text object (of type CDM_ByteSequence or CDM_RawData). CDM does not own the returned object: the caller is responsible to use Tcl_DecrRefCount or CDM_Free in order to free the object and the memory associated with it.

Return Value:

This function will return a new text object (of type CDM_ByteSequence or CDM_RawData) containing the extracted text range specified by the parameters "start" and "end".

In case of an error, NULL will be return and an error message will be left at the current active Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to "string range" Tcl facility.

See Also:

Tcl_GetRange


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