Package ghidra.app.cmd.function

Class SetVariableNameCmd

java.lang.Object

ghidra.app.cmd.function.SetVariableNameCmd

All Implemented Interfaces:

Command<Program>

public class SetVariableNameCmd
extends Object
implements Command<Program>

Command to rename a stack variable.

Constructor Summary

Constructors

Constructor	Description
SetVariableNameCmd(Address fnEntry, String varName, String newName, SourceType source)	Constructs a new command to rename a stack/reg variable.
SetVariableNameCmd(Variable var, String newName, SourceType source)	Constructs a new command to rename a stack/reg variable.

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

SetVariableNameCmd

public SetVariableNameCmd(Variable var,
 String newName,
 SourceType source)

Constructs a new command to rename a stack/reg variable.

Parameters:

var - variable to rename

newName - the new name to give to the stack variable.

source - the source of this variable name

SetVariableNameCmd

public SetVariableNameCmd(Address fnEntry,
 String varName,
 String newName,
 SourceType source)

Constructs a new command to rename a stack/reg variable.

Parameters:

fnEntry -

varName -

newName -

source -

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