RemoveAllReferencesCmd

java.lang.Object

ghidra.app.cmd.refs.RemoveAllReferencesCmd

All Implemented Interfaces:: Command<Program>

public class RemoveAllReferencesCmd extends Object implements Command<Program>

Command to remove all references at an address or for a particular operand index at an address.

Constructor Summary

Constructors

Constructor

Description

RemoveAllReferencesCmd(Address fromAddr)

Constructs a new command for removing all references.

RemoveAllReferencesCmd(Address fromAddr, int opIndex)

Constructs a new command for removing all references.
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
- RemoveAllReferencesCmd
  
  public RemoveAllReferencesCmd(Address fromAddr)
  
  Constructs a new command for removing all references.
  
  Parameters:
  
  fromAddr - the address of the codeunit making the reference.
- RemoveAllReferencesCmd
  
  public RemoveAllReferencesCmd(Address fromAddr, int opIndex)
  
  Constructs a new command for removing all references.
  
  Parameters:
  
  fromAddr - the address of the codeunit making the reference.
  
  opIndex - the operand index.
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