Siebel eScript Language Reference > Siebel eScript Commands > Buffer Objects >

getString() Method

This method returns a string of a specified length, starting from the current cursor location.

Syntax

bufferVar.getString( [length] )

Parameter
Description
length
The length of the string to return, in bytes

Returns

A string of length characters, starting at the current cursor location in the buffer.

Usage

This method returns a string starting from the current cursor location and continuing for length bytes.

If no length is specified, the method reads until a null byte is encountered or the end of the buffer is reached. The string is read according to the value of the unicode flag of the buffer. A terminating null byte is not added, even if a length parameter is not provided.

See Also

getValue() Method, offset[] Method, and size Property


 Siebel eScript Language Reference 
 Published: 18 April 2003