SetFunctionPurgeCommand

java.lang.Object

ghidra.app.cmd.function.SetFunctionPurgeCommand

All Implemented Interfaces:: Command<Program>

public class SetFunctionPurgeCommand extends Object implements Command<Program>

A simple command to set the stack purge size of a function.

Since:: Tracker Id 548

Constructor Summary

Constructors

Constructor

Description

SetFunctionPurgeCommand(Function function, int newPurge)

Creates a new command that will set the given purge size on the given function.
Method Summary

Modifier and Type

Method

Description

boolean

applyTo(Program program)

Applies the command to the given domain object.

String

getName()

Returns the name of this command.

String

getStatusMsg()

Returns the status message indicating the status of the command.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SetFunctionPurgeCommand
  
  public SetFunctionPurgeCommand(Function function, int newPurge)
  
  Creates a new command that will set the given purge size on the given function.
  
  Parameters:
  
  function - The function on which to set the purge size.
  
  newPurge - The new stack purge size.
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
- 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
- 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