Bookshelf Home | Contents | Index | PDF     

Siebel eScript Language Reference > Siebel eScript Commands > Buffer Object Methods >

getValue() Method

This method returns a value from the current cursor position in a Buffer object.

Syntax

bufferVar.getValue([valueSize][, valueType ])

Parameter
Description

valueSize

A positive number indicating the number of bytes to be read; default is 1

valueType

The type of data to be read, expressed as one of the following:

  • signed (the default)
  • unsigned
  • float
Returns

The value at the current position in a Buffer object.

Usage

To determine where to read from the buffer, use the bufferVar.cursor() method.

Acceptable values for valueSize are 1, 2, 3, 4, 8, and 10, providing that valueSize does not conflict with the optional valueType flag. The following list describes the acceptable combinations of valueSize and valueType:

valueSize
valueType

1

signed, unsigned

2

signed, unsigned

3

signed, unsigned

4

signed, unsigned, float

8

float

The combination of valueSize and valueType must match the data to be read.

See Also

putValue() Method

    
Siebel eScript Language Reference