Package ghidra.app.cmd.function

Class ChangeFunctionTagCmd

java.lang.Object

ghidra.app.cmd.function.ChangeFunctionTagCmd

All Implemented Interfaces:

Command<Program>

public class ChangeFunctionTagCmd
extends Object
implements Command<Program>

Updates the name or comment field for a given function tag

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG_COMMENT_CHANGED
static final int	TAG_NAME_CHANGED

Constructor Summary

Constructors

Constructor	Description
ChangeFunctionTagCmd(String tagName, String newVal, int field)	Constructor

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

Field Details

TAG_NAME_CHANGED

public static final int TAG_NAME_CHANGED

See Also:

• Constant Field Values

TAG_COMMENT_CHANGED

public static final int TAG_COMMENT_CHANGED

See Also:

• Constant Field Values

Constructor Details

ChangeFunctionTagCmd

public ChangeFunctionTagCmd(String tagName,
 String newVal,
 int field)

Constructor

Parameters:

tagName - the name of the tag to change

newVal - the new value to set

field - the field to set

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