Class AddMemoryVarCmd

java.lang.Object
ghidra.app.cmd.function.AddMemoryVarCmd
All Implemented Interfaces:
Command<Program>

public class AddMemoryVarCmd extends Object implements Command<Program>
Command to add a memory variable to a function.
  • Constructor Details

    • AddMemoryVarCmd

      public AddMemoryVarCmd(Address memAddr, Address firstUseAddr, String name, SourceType source)
      Constructs a new command to add a memory variable to a function.
      Parameters:
      memAddr - memory variable address
      firstUseAddr - initial declaration point of variable.
      name - name of the new variable.
      source - the source of this memory variable
    • AddMemoryVarCmd

      public AddMemoryVarCmd(Address memAddr, Address firstUseAddr, String name, DataType dt, SourceType source)
      Constructs a new command to add a memory variable to a function.
      Parameters:
      memAddr - memory variable address
      firstUseAddr - initial declaration point of variable.
      name - name of the new variable.
      dt - variable data type
      source - the source of this memory variable
  • Method Details

    • applyTo

      public boolean applyTo(Program program)
      Description copied from interface: Command
      Applies the command to the given domain object.
      Specified by:
      applyTo in interface Command<Program>
      Parameters:
      program - domain object that this command is to be applied.
      Returns:
      true if the command applied successfully
    • getName

      public String getName()
      Description copied from interface: Command
      Returns the name of this command.
      Specified by:
      getName in interface Command<Program>
      Returns:
      the name of this command
    • getStatusMsg

      public String getStatusMsg()
      Description copied from interface: Command
      Returns the status message indicating the status of the command.
      Specified by:
      getStatusMsg in interface Command<Program>
      Returns:
      reason for failure, or null if the status of the command was successful