BinHandle (B2R2)

BinHandle Type

Namespace: B2R2.FrontEnd
Assembly: B2R2.FrontEnd.Core.dll
Base Type: obj

The main handle for reading/parsing a binary code. `BinHandle` essentially provides an interface for a chunk of binary code for parsing instructions, lifting instructions, or reading data from it.

Constructors

Constructor	Description
`BinHandle(isa)` Full Usage: `BinHandle(isa)` Parameters: isa : `ISA` Returns: `BinHandle`	Construct an empty BinHandle. isa : `ISA` Returns: `BinHandle`
`BinHandle(bytes, isa)` Full Usage: `BinHandle(bytes, isa)` Parameters: bytes : `byte[]` isa : `ISA` Returns: `BinHandle`	Construct a BinHandle from a given byte array and ISA. ArchOperationMode is set to NoMode, base address is set to 0UL, and file format detection is disabled. bytes : `byte[]` isa : `ISA` Returns: `BinHandle`
`BinHandle(bytes, isa, mode, baseAddrOpt, detectFormat)` Full Usage: `BinHandle(bytes, isa, mode, baseAddrOpt, detectFormat)` Parameters: bytes : `byte[]` isa : `ISA` mode : `ArchOperationMode` baseAddrOpt : `Addr option` detectFormat : `bool` Returns: `BinHandle`	Construct a BinHandle from a given byte array. File format detection is performed only if detectFormat is set to true. bytes : `byte[]` isa : `ISA` mode : `ArchOperationMode` baseAddrOpt : `Addr option` detectFormat : `bool` Returns: `BinHandle`
`BinHandle(path)` Full Usage: `BinHandle(path)` Parameters: path : `string` Returns: `BinHandle`	Construct a BinHandle from a given file path. ISA is set to `ISA.DefaultISA` and ArchOperationMode is set to NoMode. path : `string` Returns: `BinHandle`
`BinHandle(path, isa)` Full Usage: `BinHandle(path, isa)` Parameters: path : `string` isa : `ISA` Returns: `BinHandle`	Construct a BinHandle from a given file path and ISA. ArchOperationMode is set to NoMode. path : `string` isa : `ISA` Returns: `BinHandle`
`BinHandle(path, isa, baseAddrOpt)` Full Usage: `BinHandle(path, isa, baseAddrOpt)` Parameters: path : `string` isa : `ISA` baseAddrOpt : `Addr option` Returns: `BinHandle`	Construct a BinHandle from a given file path, ISA, and optional base address (baseAddrOpt). ArchOperationMode is set to NoMode. path : `string` isa : `ISA` baseAddrOpt : `Addr option` Returns: `BinHandle`
`BinHandle(path, isa, mode, baseAddrOpt)` Full Usage: `BinHandle(path, isa, mode, baseAddrOpt)` Parameters: path : `string` isa : `ISA` mode : `ArchOperationMode` baseAddrOpt : `Addr option` Returns: `BinHandle`	Construct a BinHandle from a given file path, ISA, optional base address (baseAddrOpt), and ArchOperationMode. File format will be automatically detected. path : `string` isa : `ISA` mode : `ArchOperationMode` baseAddrOpt : `Addr option` Returns: `BinHandle`

Instance members

Instance member	Description
`this.File` Full Usage: `this.File` Returns: `IBinFile`	File handle. Returns: `IBinFile`
`this.MakeNew` Full Usage: `this.MakeNew` Parameters: bs : `byte[]` - The byte array. baseAddr : `Addr` - The new base address. Returns: `BinHandle` Return a new BinHandle.	Create a new BinHandle from the given byte array while keeping the other properties of the original BinHandle. bs : `byte[]` The byte array. baseAddr : `Addr` The new base address. Returns: `BinHandle` Return a new BinHandle.
`this.MakeNew` Full Usage: `this.MakeNew` Parameters: bs : `byte[]` - The byte array. Returns: `BinHandle` Return a new BinHandle.	Create a new BinHandle from the given byte array while keeping the other properties of the original BinHandle. bs : `byte[]` The byte array. Returns: `BinHandle` Return a new BinHandle.
`this.NewLiftingUnit` Full Usage: `this.NewLiftingUnit` Returns: `LiftingUnit`	Get a new instance of lifting unit. Returns: `LiftingUnit`
`this.ReadASCII` Full Usage: `this.ReadASCII` Parameters: ptr : `BinFilePointer` - BinFilePointer. Returns: `string` Return the corresponding ASCII string.	Return the ASCII string pointed to by the binary file pointer from the given BinHandle. ptr : `BinFilePointer` BinFilePointer. Returns: `string` Return the corresponding ASCII string.
`this.ReadASCII` Full Usage: `this.ReadASCII` Parameters: addr : `Addr` - The address. Returns: `string` Return the corresponding ASCII string.	Return the ASCII string at the addr from the given BinHandle. addr : `Addr` The address. Returns: `string` Return the corresponding ASCII string.
`this.ReadBytes` Full Usage: `this.ReadBytes` Parameters: ptr : `BinFilePointer` - BInaryPointer. nBytes : `int` - The size of the byte array (in bytes). Returns: `byte[]` Return the byte array if succeed. Otherwise, raise an exception.	Return the byte array of size (nBytes) pointed to by the binary file pointer (ptr). ptr : `BinFilePointer` BInaryPointer. nBytes : `int` The size of the byte array (in bytes). Returns: `byte[]` Return the byte array if succeed. Otherwise, raise an exception.
`this.ReadBytes` Full Usage: `this.ReadBytes` Parameters: addr : `Addr` - The address. nBytes : `int` - The size of the byte array (in bytes). Returns: `byte[]` Return the byte array if succeed. Otherwise, raise an exception.	Return the byte array of size (nBytes) at the addr from the current binary. addr : `Addr` The address. nBytes : `int` The size of the byte array (in bytes). Returns: `byte[]` Return the byte array if succeed. Otherwise, raise an exception.
`this.ReadInt` Full Usage: `this.ReadInt` Parameters: ptr : `BinFilePointer` - The binary pointer. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `int64` Return the corresponding integer (int64).	Return the corresponding integer value of the size from the current binary, which is pointed to by the binary file pointer (ptr). ptr : `BinFilePointer` The binary pointer. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `int64` Return the corresponding integer (int64).
`this.ReadInt` Full Usage: `this.ReadInt` Parameters: addr : `Addr` - The address. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `int64` Return the corresponding integer (int64).	Return the corresponding integer value at the addr of the size from the current binary. addr : `Addr` The address. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `int64` Return the corresponding integer (int64).
`this.ReadUInt` Full Usage: `this.ReadUInt` Parameters: ptr : `BinFilePointer` - BinFilePointer. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `uint64` Return the corresponding unsigned integer (uint64).	Return the corresponding unsigned integer value of the size from the binary, which is pointed to by the binary file pointer (ptr). ptr : `BinFilePointer` BinFilePointer. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `uint64` Return the corresponding unsigned integer (uint64).
`this.ReadUInt` Full Usage: `this.ReadUInt` Parameters: addr : `Addr` - The address. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `uint64` Return the corresponding unsigned integer (uint64).	Return the corresponding unsigned integer value at the addr of the size from the binary. addr : `Addr` The address. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `uint64` Return the corresponding unsigned integer (uint64).
`this.RegisterFactory` Full Usage: `this.RegisterFactory` Returns: `RegisterFactory`	Register factory. Returns: `RegisterFactory`
`this.TryReadBytes` Full Usage: `this.TryReadBytes` Parameters: ptr : `BinFilePointer` - The binary pointer. nBytes : `int` - The size of the byte array (in bytes). Returns: `Result<byte[], ErrorCase>` Return (byte[]) if succeeded, (ErrorCase) otherwise.	Return the byte array of size (nBytes) pointed to by the pointer (ptr). ptr : `BinFilePointer` The binary pointer. nBytes : `int` The size of the byte array (in bytes). Returns: `Result<byte[], ErrorCase>` Return (byte[]) if succeeded, (ErrorCase) otherwise.
`this.TryReadBytes` Full Usage: `this.TryReadBytes` Parameters: addr : `Addr` - The address. nBytes : `int` - The size of the byte array (in bytes). Returns: `Result<byte[], ErrorCase>` Return (byte[]) if succeeded, (ErrorCase) otherwise.	Return the byte array of size (nBytes) located at the address (addr). addr : `Addr` The address. nBytes : `int` The size of the byte array (in bytes). Returns: `Result<byte[], ErrorCase>` Return (byte[]) if succeeded, (ErrorCase) otherwise.
`this.TryReadInt` Full Usage: `this.TryReadInt` Parameters: ptr : `BinFilePointer` - BinFilePointer. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<int64, ErrorCase>` Return the corresponding value (int64) if the address and the size is valid. Otherwise ErrorCase.	Return the corresponding integer of the size from the given address pointed to by the binary pointer (ptr). ptr : `BinFilePointer` BinFilePointer. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<int64, ErrorCase>` Return the corresponding value (int64) if the address and the size is valid. Otherwise ErrorCase.
`this.TryReadInt` Full Usage: `this.TryReadInt` Parameters: addr : `Addr` - The address. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<int64, ErrorCase>` Return the corresponding value (int64) if the address and the size is valid. Otherwise ErrorCase.	Return the corresponding integer of the size from the given address. addr : `Addr` The address. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<int64, ErrorCase>` Return the corresponding value (int64) if the address and the size is valid. Otherwise ErrorCase.
`this.TryReadUInt` Full Usage: `this.TryReadUInt` Parameters: ptr : `BinFilePointer` - BinFilePointer. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<uint64, ErrorCase>` Return the corresponding unsigned integer (uint64) if the address and the size is valid. Otherwise, ErrorCase.	Return the corresponding unsigned integer of the size from the address pointed to by the binary file pointer (ptr). ptr : `BinFilePointer` BinFilePointer. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<uint64, ErrorCase>` Return the corresponding unsigned integer (uint64) if the address and the size is valid. Otherwise, ErrorCase.
`this.TryReadUInt` Full Usage: `this.TryReadUInt` Parameters: addr : `Addr` - The address. size : `int` - The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<uint64, ErrorCase>` Return the corresponding unsigned integer (uint64) if the address and the size is valid. Otherwise, ErrorCase.	Return the corresponding unsigned integer of the size from the given address. addr : `Addr` The address. size : `int` The size of the integer in bytes. Maximum 8 bytes is possible. Returns: `Result<uint64, ErrorCase>` Return the corresponding unsigned integer (uint64) if the address and the size is valid. Otherwise, ErrorCase.