DataBuffer (Object)

Definition:
A block of memory set aside to store data.

Specialized Features:
The following tables list and describe the properties and methods added by DataBuffer. There are no added events.

Properties Use to...

Data Display the address of the allocated memory.

DataAllocated Indicate whether or not memory has been allocated to hold data.

DataIsValidForRead Indicate that the memory location is readable.

DataIsValidForWrite Indicate that the memory location is writeable.

Persistent Determine whether or not the contents of the DataBuffer will be saved.

Size Set the size of the DataBuffer in bytes.

Methods Use to...

CopyBuffer Copy the contents of one DataBuffer to another.

FillBytes Set several Bytes to a single value.

GetBit Look at the status of a single Bit.

GetByte Find the value of a single Byte.

GetDouble Find a value of type Double.

GetInteger Find a value of type Integer.

GetLong Find a value of type Long.

GetSingle Find a value of type Single.

GetString Find a String value.

GetStringN Find part of a String value.

HexDump Get a Hexadecimal representation of the DataBuffer's contents.

SetBit Set the state of a single Bit.

SetByte Set the value of a single Byte.

SetDouble Set a value of type Double.

SetInteger Set a value of type Integer.

SetLong Set a value of type Long.

SetString Set a String value.

SetStringN Set part of a String Value

SetSingle Set a value of type Single.

TextUnload Write a text representation of a window.

Copied Features:
None

this is a top-level object.

Details:
DataBuffers can be used to store and retrieve data of types Integer, Long, Single, Double, and String. Before anything can be stored in a Databuffer, its Size property must be set. The methods for setting and getting values often require a starting position (in Bytes). Several methods in Phoenix use Databuffers to interact with the programming environment.