BinaryNinja::WorkflowMachine Class Reference

Public Member Functions
	WorkflowMachine (Ref< BinaryView > view)
	WorkflowMachine (Ref< Function > function)
bool	PostJsonRequest (const std::string &request)
bool	Run ()
	Start the workflow WorkflowMachine Starts the workflow machine for the given BinaryView or Function.
bool	Halt ()
	Halt the workflow machine.
bool	Reset ()
	Reset the workflow machine.
bool	Enable ()
	Enable the workflow machine.
bool	Disable ()
	Disable the workflow machine.
bool	Step ()
	Step the workflow machine.
std::string	GetState ()
std::pair< bool, bool >	GetLogStatus ()
bool	SetLogEnabled (bool enable, bool global=false)
std::optional< bool >	QueryOverride (const std::string &activity)
bool	SetOverride (const std::string &activity, bool enable)
bool	ClearOverride (const std::string &activity)

Constructor & Destructor Documentation

WorkflowMachine() [1/2]

WorkflowMachine::WorkflowMachine

(

Ref< BinaryView >

view

)

WorkflowMachine() [2/2]

WorkflowMachine::WorkflowMachine

(

Ref< Function >

function

)

Member Function Documentation

PostJsonRequest()

bool WorkflowMachine::PostJsonRequest

(

const std::string &

request

)

Run()

bool WorkflowMachine::Run

(

)

Start the workflow WorkflowMachine Starts the workflow machine for the given BinaryView or Function.

Returns

true if the command is accepted, false otherwise.

Halt()

bool WorkflowMachine::Halt

(

)

Halt the workflow machine.

Halts analysis at a resumable point.

Returns

true if the command is accepted, false otherwise.

Reset()

bool WorkflowMachine::Reset

(

)

Reset the workflow machine.

Resets the workflow machine to its initial state.

Returns

true if the command is accepted, false otherwise.

Enable()

bool WorkflowMachine::Enable

(

)

Enable the workflow machine.

Re-enables the workflow machine if it is in the Suspend state.

Returns

true if the command is accepted, false otherwise.

Disable()

bool WorkflowMachine::Disable

(

)

Disable the workflow machine.

Disables analysis and suspends the workflow machine, equivalent to AbortAnalysis. This operation is recoverable and the workflow machine can be re-enabled via the Enable API.

Returns

true if the command is accepted, false otherwise.

Step()

bool WorkflowMachine::Step

(

)

Step the workflow machine.

Steps the workflow machine through a single activity.

Returns

true if the command is accepted, false otherwise.

GetState()

string WorkflowMachine::GetState

(

)

GetLogStatus()

std::pair< bool, bool > WorkflowMachine::GetLogStatus

(

)

SetLogEnabled()

bool WorkflowMachine::SetLogEnabled	(	bool	enable,
		bool	global = false )

QueryOverride()

std::optional< bool > WorkflowMachine::QueryOverride

(

const std::string &

activity

)

SetOverride()

bool WorkflowMachine::SetOverride	(	const std::string &	activity,
		bool	enable )

ClearOverride()

bool WorkflowMachine::ClearOverride

(

const std::string &

activity

)