Package ghidra.app.cmd.function

Class SetVariableDataTypeCmd

java.lang.Object

ghidra.app.cmd.function.SetVariableDataTypeCmd

All Implemented Interfaces:

Command<Program>

public class SetVariableDataTypeCmd
extends Object
implements Command<Program>

Command to set the datatype on a stack variable.

Constructor Summary

Constructors

Constructor	Description
SetVariableDataTypeCmd(Address fnEntry, String varName, DataType dataType, boolean align, boolean force, SourceType source)	Constructs a new command for setting the datatype on a stack/reg variable
SetVariableDataTypeCmd(Address fnEntry, String varName, DataType dataType, SourceType source)	Constructs a new command for setting the datatype on a stack/reg variable.
SetVariableDataTypeCmd(Variable var, DataType dataType, SourceType source)	Constructs a new command for setting the datatype on 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

SetVariableDataTypeCmd

public SetVariableDataTypeCmd(Variable var,
 DataType dataType,
 SourceType source)

Constructs a new command for setting the datatype on a stack/reg variable. Conflicting stack variables will be removed.

Parameters:

var - the variable for which to set the datatype.

dataType - the datatype to apply to the stack variable.

source - signature source

SetVariableDataTypeCmd

public SetVariableDataTypeCmd(Address fnEntry,
 String varName,
 DataType dataType,
 SourceType source)

Constructs a new command for setting the datatype on a stack/reg variable. Conflicting stack variables will be removed.

Parameters:

fnEntry -

varName -

dataType -

source - signature source

SetVariableDataTypeCmd

public SetVariableDataTypeCmd(Address fnEntry,
 String varName,
 DataType dataType,
 boolean align,
 boolean force,
 SourceType source)

Constructs a new command for setting the datatype on a stack/reg variable

Parameters:

fnEntry -

varName -

dataType -

align - maintain proper alignment/justification if supported by implementation (ignored for non-stack variables). If false and this is a stack variable, the current stack address/offset will not change. If true, the affect is implementation dependent since alignment can not be performed without access to a compiler specification.

force - overwrite conflicting stack variables

source - signature source

Method Details

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

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

See Also:

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

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

See Also:

• Command.getStatusMsg()