All Superinterfaces:

StructConverter

All Known Implementing Classes:

OptionalHeaderImpl
```
public interface OptionalHeader
extends StructConverter
```

Field Summary

Fields
Modifier and Type	Field	Description
`static byte`	`IMAGE_DIRECTORY_ENTRY_ARCHITECTURE`	Architecture Specific Data directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_BASERELOC`	Base Relocation Table directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT`	Bound Import directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR`	COM Runtime Descriptor directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_COMHEADER`	New name for the COM Descriptor directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_DEBUG`	Debug directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT`	Delay Load Import Descriptors directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_EXCEPTION`	Exception directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_EXPORT`	Export directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_GLOBALPTR`	Global Pointer directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_IAT`	Import Address Table directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_IMPORT`	Import directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG`	Load Configuration directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_RESOURCE`	Resource directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_SECURITY`	Security directory index
`static byte`	`IMAGE_DIRECTORY_ENTRY_TLS`	TLS directory index
`static byte`	`IMAGE_NUMBEROF_DIRECTORY_ENTRIES`	The count of data directories in the optional header.

Fields inherited from interface ghidra.app.util.bin.StructConverter
ASCII, BYTE, DWORD, IBO32, POINTER, QWORD, STRING, UTF16, UTF8, VOID, WORD

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getAddressOfEntryPoint()`
`long`	`getBaseOfCode()`	Returns the RVA of the first byte of code when loaded in memory.
`long`	`getBaseOfData()`
`int`	`getChecksum()`	Get the image file checksum.
`DataDirectory[]`	`getDataDirectories()`	Returns the array of data directories.
`short`	`getDllCharacteristics()`	Return flags that describe properties of and features of this binary.
`int`	`getFileAlignment()`
`long`	`getImageBase()`
`int`	`getLoaderFlags()`	Return the flags passed to the loader.
`short`	`getMajorImageVersion()`	Get the major version number of the image.
`byte`	`getMajorLinkerVersion()`	Return the major version number of the linker that built this binary.
`short`	`getMajorOperatingSystemVersion()`	Return the major version number of the required operating system.
`short`	`getMajorSubsystemVersion()`	Get the major version number of the subsystem.
`short`	`getMinorImageVersion()`	Get the minor version number of the image.
`byte`	`getMinorLinkerVersion()`	Return the minor version number of the linker that built this binary.
`short`	`getMinorOperatingSystemVersion()`	Return the minor version number of the required operating system.
`short`	`getMinorSubsystemVersion()`	Get the minor version number of the subsystem.
`long`	`getNumberOfRvaAndSizes()`
`long`	`getOriginalImageBase()`
`int`	`getSectionAlignment()`
`long`	`getSizeOfCode()`	Returns the combined total size of all sections with the `IMAGE_SCN_CNT_CODE` attribute.
`long`	`getSizeOfHeaders()`
`long`	`getSizeOfHeapCommit()`	Return the size of the heap to commit
`long`	`getSizeOfHeapReserve()`	Return the size of the heap reservation
`long`	`getSizeOfImage()`
`long`	`getSizeOfInitializedData()`	Returns the combined size of all initialized data sections.
`long`	`getSizeOfStackCommit()`	Return the size of the stack to commit
`long`	`getSizeOfStackReserve()`	Return the size of the stack reservation
`long`	`getSizeOfUninitializedData()`	Returns the size of all sections with the uninitialized data attributes.
`int`	`getSubsystem()`	Get the subsystem that is required to run this image.
`int`	`getWin32VersionValue()`	This value is reserved, and must be 0
`boolean`	`is64bit()`	Returns true of this optional header is 64-bit.
`boolean`	`isCLI()`
`void`	`processDataDirectories(TaskMonitor monitor)`	This methods tells this optional header to process its data directories.
`void`	`setSizeOfCode(long size)`
`void`	`setSizeOfHeaders(long size)`
`void`	`setSizeOfImage(long size)`
`void`	`setSizeOfInitializedData(long size)`
`void`	`setSizeOfUninitializedData(long size)`
`void`	`validateDataDirectories(Program program)`
`boolean`	`wasRebased()`
`void`	`writeHeader(java.io.RandomAccessFile raf, DataConverter dc)`	Writes this optional header to the specified random access file.

Methods inherited from interface ghidra.app.util.bin.StructConverter
toDataType

- Field Detail
  - IMAGE_NUMBEROF_DIRECTORY_ENTRIES
```
static final byte IMAGE_NUMBEROF_DIRECTORY_ENTRIES
```
    The count of data directories in the optional header.
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_EXPORT
```
static final byte IMAGE_DIRECTORY_ENTRY_EXPORT
```
    Export directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_IMPORT
```
static final byte IMAGE_DIRECTORY_ENTRY_IMPORT
```
    Import directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_RESOURCE
```
static final byte IMAGE_DIRECTORY_ENTRY_RESOURCE
```
    Resource directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_EXCEPTION
```
static final byte IMAGE_DIRECTORY_ENTRY_EXCEPTION
```
    Exception directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_SECURITY
```
static final byte IMAGE_DIRECTORY_ENTRY_SECURITY
```
    Security directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_BASERELOC
```
static final byte IMAGE_DIRECTORY_ENTRY_BASERELOC
```
    Base Relocation Table directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_DEBUG
```
static final byte IMAGE_DIRECTORY_ENTRY_DEBUG
```
    Debug directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_ARCHITECTURE
```
static final byte IMAGE_DIRECTORY_ENTRY_ARCHITECTURE
```
    Architecture Specific Data directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_GLOBALPTR
```
static final byte IMAGE_DIRECTORY_ENTRY_GLOBALPTR
```
    Global Pointer directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_TLS
```
static final byte IMAGE_DIRECTORY_ENTRY_TLS
```
    TLS directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG
```
static final byte IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG
```
    Load Configuration directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT
```
static final byte IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT
```
    Bound Import directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_IAT
```
static final byte IMAGE_DIRECTORY_ENTRY_IAT
```
    Import Address Table directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT
```
static final byte IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT
```
    Delay Load Import Descriptors directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR
```
static final byte IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR
```
    COM Runtime Descriptor directory index
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIRECTORY_ENTRY_COMHEADER
```
static final byte IMAGE_DIRECTORY_ENTRY_COMHEADER
```
    New name for the COM Descriptor directory index
    
    See Also:
    
    Constant Field Values
- Method Detail
  - is64bit
```
boolean is64bit()
```
    Returns true of this optional header is 64-bit.
    
    Returns:
    
    true of this optional header is 64-bit
  - getMajorLinkerVersion
```
byte getMajorLinkerVersion()
```
    Return the major version number of the linker that built this binary.
    
    Returns:
  - getMinorLinkerVersion
```
byte getMinorLinkerVersion()
```
    Return the minor version number of the linker that built this binary.
    
    Returns:
  - getMajorOperatingSystemVersion
```
short getMajorOperatingSystemVersion()
```
    Return the major version number of the required operating system.
    
    Returns:
  - getMinorOperatingSystemVersion
```
short getMinorOperatingSystemVersion()
```
    Return the minor version number of the required operating system.
    
    Returns:
  - getMajorImageVersion
```
short getMajorImageVersion()
```
    Get the major version number of the image.
    
    Returns:
  - getMinorImageVersion
```
short getMinorImageVersion()
```
    Get the minor version number of the image.
    
    Returns:
  - getMajorSubsystemVersion
```
short getMajorSubsystemVersion()
```
    Get the major version number of the subsystem.
  - getMinorSubsystemVersion
```
short getMinorSubsystemVersion()
```
    Get the minor version number of the subsystem.
    
    Returns:
  - getWin32VersionValue
```
int getWin32VersionValue()
```
    This value is reserved, and must be 0
  - getChecksum
```
int getChecksum()
```
    Get the image file checksum.
    
    Returns:
  - getSubsystem
```
int getSubsystem()
```
    Get the subsystem that is required to run this image.
    
    Returns:
  - getDllCharacteristics
```
short getDllCharacteristics()
```
    Return flags that describe properties of and features of this binary.
    
    Returns:
    
    See Also:
    
    DllCharacteristics
  - getSizeOfStackReserve
```
long getSizeOfStackReserve()
```
    Return the size of the stack reservation
    
    Returns:
  - getSizeOfStackCommit
```
long getSizeOfStackCommit()
```
    Return the size of the stack to commit
    
    Returns:
  - getSizeOfHeapReserve
```
long getSizeOfHeapReserve()
```
    Return the size of the heap reservation
    
    Returns:
  - getSizeOfHeapCommit
```
long getSizeOfHeapCommit()
```
    Return the size of the heap to commit
    
    Returns:
  - getLoaderFlags
```
int getLoaderFlags()
```
    Return the flags passed to the loader. Obsolete.
    
    Returns:
  - getAddressOfEntryPoint
```
long getAddressOfEntryPoint()
```
    Returns:
    
    the RVA of the first code byte in the file that will be executed
  - getImageBase
```
long getImageBase()
```
    Returns:
    
    the preferred load address of this file in memory
  - getOriginalImageBase
```
long getOriginalImageBase()
```
  - wasRebased
```
boolean wasRebased()
```
  - getSizeOfImage
```
long getSizeOfImage()
```
    Returns:
    
    the RVA that would be assigned to the next section following the last section
  - setSizeOfImage
```
void setSizeOfImage(long size)
```
    See Also:
    
    getSizeOfImage()
  - getSizeOfHeaders
```
long getSizeOfHeaders()
```
    Returns:
    
    the combined size of all headers
  - setSizeOfHeaders
```
void setSizeOfHeaders(long size)
```
    See Also:
    
    getSizeOfHeaders()
  - getSizeOfCode
```
long getSizeOfCode()
```
    Returns the combined total size of all sections with the IMAGE_SCN_CNT_CODE attribute.
    
    Returns:
    
    the combined total size of all sections with the IMAGE_SCN_CNT_CODE attribute.
  - setSizeOfCode
```
void setSizeOfCode(long size)
```
    See Also:
    
    getSizeOfCode()
  - getNumberOfRvaAndSizes
```
long getNumberOfRvaAndSizes()
```
  - getSizeOfInitializedData
```
long getSizeOfInitializedData()
```
    Returns the combined size of all initialized data sections.
    
    Returns:
    
    the combined size of all initialized data sections
  - setSizeOfInitializedData
```
void setSizeOfInitializedData(long size)
```
    See Also:
    
    getSizeOfInitializedData()
  - getSizeOfUninitializedData
```
long getSizeOfUninitializedData()
```
    Returns the size of all sections with the uninitialized data attributes.
    
    Returns:
    
    the size of all sections with the uninitialized data attributes
  - setSizeOfUninitializedData
```
void setSizeOfUninitializedData(long size)
```
    See Also:
    
    getSizeOfUninitializedData()
  - getBaseOfCode
```
long getBaseOfCode()
```
    Returns the RVA of the first byte of code when loaded in memory.
    
    Returns:
    
    the RVA of the first byte of code when loaded in memory
  - getBaseOfData
```
long getBaseOfData()
```
    Returns:
    
    the RVA of the first byte of data when loaded into memory
  - processDataDirectories
```
void processDataDirectories(TaskMonitor monitor)
                     throws java.io.IOException
```
    This methods tells this optional header to process its data directories.
    
    Throws:
    
    java.io.IOException
  - getDataDirectories
```
DataDirectory[] getDataDirectories()
```
    Returns the array of data directories.
    
    Returns:
    
    the array of data directories
  - getSectionAlignment
```
int getSectionAlignment()
```
    Returns:
    
    the section alignment
  - getFileAlignment
```
int getFileAlignment()
```
    Returns:
    
    the file alignment
  - writeHeader
```
void writeHeader(java.io.RandomAccessFile raf,
                 DataConverter dc)
          throws java.io.IOException
```
    Writes this optional header to the specified random access file.
    
    Parameters:
    
    raf - the random access file
    
    dc - the data converter
    
    Throws:
    
    java.io.IOException
  - validateDataDirectories
```
void validateDataDirectories(Program program)
```
  - isCLI
```
boolean isCLI()
       throws java.io.IOException
```
    Returns:
    
    true if the PE uses predominantly CLI code; otherwise, false.
    
    Throws:
    
    java.io.IOException

Interface OptionalHeader

Field Summary

Fields inherited from interface ghidra.app.util.bin.StructConverter

Method Summary

Methods inherited from interface ghidra.app.util.bin.StructConverter

Field Detail

IMAGE_NUMBEROF_DIRECTORY_ENTRIES

IMAGE_DIRECTORY_ENTRY_EXPORT

IMAGE_DIRECTORY_ENTRY_IMPORT

IMAGE_DIRECTORY_ENTRY_RESOURCE

IMAGE_DIRECTORY_ENTRY_EXCEPTION

IMAGE_DIRECTORY_ENTRY_SECURITY

IMAGE_DIRECTORY_ENTRY_BASERELOC

IMAGE_DIRECTORY_ENTRY_DEBUG

IMAGE_DIRECTORY_ENTRY_ARCHITECTURE

IMAGE_DIRECTORY_ENTRY_GLOBALPTR

IMAGE_DIRECTORY_ENTRY_TLS

IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG

IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT

IMAGE_DIRECTORY_ENTRY_IAT

IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT

IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR

IMAGE_DIRECTORY_ENTRY_COMHEADER

Method Detail

is64bit

getMajorLinkerVersion

getMinorLinkerVersion

getMajorOperatingSystemVersion

getMinorOperatingSystemVersion

getMajorImageVersion

getMinorImageVersion

getMajorSubsystemVersion

getMinorSubsystemVersion

getWin32VersionValue

getChecksum

getSubsystem

getDllCharacteristics

getSizeOfStackReserve

getSizeOfStackCommit

getSizeOfHeapReserve

getSizeOfHeapCommit

getLoaderFlags

getAddressOfEntryPoint

getImageBase

getOriginalImageBase

wasRebased

getSizeOfImage

setSizeOfImage

getSizeOfHeaders

setSizeOfHeaders

getSizeOfCode

setSizeOfCode

getNumberOfRvaAndSizes

getSizeOfInitializedData

setSizeOfInitializedData

getSizeOfUninitializedData

setSizeOfUninitializedData

getBaseOfCode

getBaseOfData

processDataDirectories

getDataDirectories

getSectionAlignment

getFileAlignment

writeHeader

validateDataDirectories

isCLI