GetUint8 - method of the PmBuffer object

Description:

Reading integer 1-byte unsigned value.

Syntax:

Long GetUint8(Long nOffset)

Parameters:

nOffset	(Long) Specifies the position of read value in the data block. The read value must be inside the data block. The item is read either whole or not read at all. >= 0 - Index (in bytes, zero-based index) in the data block. -4 - The internal automatic position is used (see the AutoOffset property). It points behind the last read or written value. This operation shifts the internal automatic position behind the read/written value. If the items are read/written one by one then it is not necessary to define the position manually, but it is better to use this automated positioning.

nOffset

(Long) Specifies the position of read value in the data block.
The read value must be inside the data block. The item is read either whole or not read at all.

>= 0 - Index (in bytes, zero-based index) in the data block.

-4 - The internal automatic position is used (see the AutoOffset property). It points behind the last read or written value.
This operation shifts the internal automatic position behind the read/written value.
If the items are read/written one by one then it is not necessary to define the position manually, but it is better to use this automated positioning.

Note:

This method is also functional in Web panels.

In case of an error, this method returns the 0 value.

Example:

JavaScriptSelect and copy to clipboard



var oBuf = Pm.CreatePmBuffer();

oBuf.SetUint8(-2, 127);

oBuf.SetUint8(-2, -11);


var val0 = oBuf.GetUint8(0);

var val1 = oBuf.GetUint8(1);
  // val1 = 0

// or

oBuf.AutoOffset = 0;

var val0 = oBuf.GetUint8(-4);

var val1 = oBuf.GetUint8(-4);
  // val1 = 0