Package ghidra.app.cmd.function

Class AddStackVarCmd

java.lang.Object

ghidra.app.cmd.function.AddStackVarCmd

All Implemented Interfaces:

Command

public class AddStackVarCmd
extends java.lang.Object
implements Command

Command to add a stack variable to a function.

Constructor Summary

Constructors

Constructor	Description
AddStackVarCmd(Address addr, int stackOffset, java.lang.String name, DataType dataType, SourceType source)	Constructs a new command to add a stack variable to a function.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.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 Detail

AddStackVarCmd

public AddStackVarCmd(Address addr,
                      int stackOffset,
                      java.lang.String name,
                      DataType dataType,
                      SourceType source)

Constructs a new command to add a stack variable to a function.

Parameters:

addr - initial declaration point of variable.

stackOffset - offset into the stack for the new variable.

name - name of the new variable.

dataType - variable data-type or null for a default data type of minimal size

source - the source of this stack variable

Method Detail

applyTo

public boolean applyTo(DomainObject obj)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command

Parameters:

obj - domain object that this command is to be applied.

Returns:

true if the command applied successfully

See Also:

Command.applyTo(ghidra.framework.model.DomainObject)

getName

public java.lang.String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command

Returns:

the name of this command

See Also:

Command.getName()

getStatusMsg

public java.lang.String getStatusMsg()

Description copied from interface: Command

Returns the status message indicating the status of the command.

Specified by:

getStatusMsg in interface Command

Returns:

reason for failure, or null if the status of the command was successful

See Also:

Command.getStatusMsg()