Class Structure

Inheritance

Object Structure 🡄 Object

Properties

Count Number of elements in the structure (ReadOnly).
Element [ index ] Returns the structure element at the given index (ReadOnly).
Name The name of the structure.
Size The number of bytes between the last element and the start (ReadOnly).

Methods

addElement () Adds a new blank structureElement and returns it.
addToGlobalStructureList () Add this to the list of structures for the user to select from.
autoGuess ( baseaddresstoguessfrom, offset, size )
beginUpdate () Call this when you want to make multiple updates to a structure.
endUpdate () Call this when done.
fillFromDotNetAddress ( address, changeName ) Fills the structure with the layout gathered from querying .NET.
getElement ( index ) Returns a structureElement object.
getElementByOffset ( offset ) Returns a structureElement object where the specified offset is at least the requested offset.
getName () Returns the name.
removeFromGlobalStructureList () Remove from the list of structures.
setName ( name ) Sets the name.


Inheritance

Object
Structure 🡄 Object

Properties

Count
Number of elements in the structure (ReadOnly).

Type:

    integer
Element [ index ]
Returns the structure element at the given index (ReadOnly).

Type:

    array
Name
The name of the structure.

Type:

Size
The number of bytes between the last element and the start (ReadOnly).

Type:

    integer

Methods

addElement ()
Adds a new blank structureElement and returns it.

Returns:

    StructureElement
addToGlobalStructureList ()
Add this to the list of structures for the user to select from.

(Global structures will get saved to the table)

autoGuess ( baseaddresstoguessfrom, offset, size )

Parameters:

  • baseaddresstoguessfrom
  • offset
  • size
beginUpdate ()
Call this when you want to make multiple updates to a structure. It will speed up the update process
endUpdate ()
Call this when done.
fillFromDotNetAddress ( address, changeName )
Fills the structure with the layout gathered from querying .NET. If changeName is true, the structure will take the name of the .NET class. (6.4+)

Parameters:

  • address
  • changeName
getElement ( index )
Returns a structureElement object.

(Changing offsets can change the index)

Parameters:

  • index integer

Returns:

    StructureElement
getElementByOffset ( offset )
Returns a structureElement object where the specified offset is at least the requested offset.

Parameters:

  • offset

Returns:

    StructureElement
getName ()
Returns the name.

Returns:

    string
removeFromGlobalStructureList ()
Remove from the list of structures.
setName ( name )
Sets the name.

Parameters:

generated by LDoc 1.4.6-antum-dev-1 Last updated 2019-02-27 23:30:35