339 lines
17 KiB
HTML
339 lines
17 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>binaryninja.interaction.get_form_input — Binary Ninja API Documentation v1.1</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="genindex.html"/>
|
|
<link rel="search" title="Search" href="search.html"/>
|
|
<link rel="top" title="Binary Ninja API Documentation v1.1" href="index.html"/>
|
|
<link rel="up" title="interaction module" href="binaryninja.interaction-module.html"/>
|
|
<link rel="next" title="binaryninja.interaction.get_int_input" href="binaryninja.interaction.get_int_input.html"/>
|
|
<link rel="prev" title="binaryninja.interaction.get_directory_name_input" href="binaryninja.interaction.get_directory_name_input.html"/>
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> Binary Ninja API
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
<script>
|
|
window.addEventListener("load", function() {
|
|
var ver = document.getElementsByClassName("version");
|
|
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.architecture-module.html">architecture</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.flowgraph-module.html">flowgraph</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.AddressField.html">binaryninja.interaction.AddressField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.ChoiceField.html">binaryninja.interaction.ChoiceField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.DirectoryNameField.html">binaryninja.interaction.DirectoryNameField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.FlowGraphReport.html">binaryninja.interaction.FlowGraphReport</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.HTMLReport.html">binaryninja.interaction.HTMLReport</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.IntegerField.html">binaryninja.interaction.IntegerField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.InteractionHandler.html">binaryninja.interaction.InteractionHandler</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.LabelField.html">binaryninja.interaction.LabelField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.MarkdownReport.html">binaryninja.interaction.MarkdownReport</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.MultilineTextField.html">binaryninja.interaction.MultilineTextField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.OpenFileNameField.html">binaryninja.interaction.OpenFileNameField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.PlainTextReport.html">binaryninja.interaction.PlainTextReport</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.ReportCollection.html">binaryninja.interaction.ReportCollection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.SaveFileNameField.html">binaryninja.interaction.SaveFileNameField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.SeparatorField.html">binaryninja.interaction.SeparatorField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.TextLineField.html">binaryninja.interaction.TextLineField</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_address_input.html">binaryninja.interaction.get_address_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_choice_input.html">binaryninja.interaction.get_choice_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_directory_name_input.html">binaryninja.interaction.get_directory_name_input</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.interaction.get_form_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_int_input.html">binaryninja.interaction.get_int_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_open_filename_input.html">binaryninja.interaction.get_open_filename_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_save_filename_input.html">binaryninja.interaction.get_save_filename_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.get_text_line_input.html">binaryninja.interaction.get_text_line_input</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.markdown_to_html.html">binaryninja.interaction.markdown_to_html</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.range.html">binaryninja.interaction.range</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_graph_report.html">binaryninja.interaction.show_graph_report</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_html_report.html">binaryninja.interaction.show_html_report</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_markdown_report.html">binaryninja.interaction.show_markdown_report</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_message_box.html">binaryninja.interaction.show_message_box</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_plain_text_report.html">binaryninja.interaction.show_plain_text_report</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.interaction.show_report_collection.html">binaryninja.interaction.show_report_collection</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.numbers-module.html">numbers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.settings-module.html">settings</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Binary Ninja API</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li><a href="binaryninja.interaction-module.html">interaction module</a> »</li>
|
|
|
|
<li>binaryninja.interaction.get_form_input</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/binaryninja.interaction.get_form_input.rst.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="binaryninja-interaction-get-form-input">
|
|
<h1>binaryninja.interaction.get_form_input<a class="headerlink" href="#binaryninja-interaction-get-form-input" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="function">
|
|
<dt id="binaryninja.interaction.get_form_input">
|
|
<code class="descname">get_form_input</code><span class="sig-paren">(</span><em>fields</em>, <em>title</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/interaction.html#get_form_input"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.interaction.get_form_input" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><code class="docutils literal notranslate"><span class="pre">get_from_input</span></code> Prompts the user for a set of inputs specified in <code class="docutils literal notranslate"><span class="pre">fields</span></code> with given title.
|
|
The fields parameter is a list which can contain the following types:</p>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li>str - an alias for LabelField</li>
|
|
<li>None - an alias for SeparatorField</li>
|
|
<li>LabelField - Text output</li>
|
|
<li>SeparatorField - Vertical spacing</li>
|
|
<li>TextLineField - Prompt for a string value</li>
|
|
<li>MultilineTextField - Prompt for multi-line string value</li>
|
|
<li>IntegerField - Prompt for an integer</li>
|
|
<li>AddressField - Prompt for an address</li>
|
|
<li>ChoiceField - Prompt for a choice from provided options</li>
|
|
<li>OpenFileNameField - Prompt for file to open</li>
|
|
<li>SaveFileNameField - Prompt for file to save to</li>
|
|
<li>DirectoryNameField - Prompt for directory name</li>
|
|
</ul>
|
|
</div></blockquote>
|
|
<p>This API is flexible and works both in the UI via a pop-up dialog and on the command-line.
|
|
:params list fields: A list containing of the above specified classes, strings or None
|
|
:params str title: The title of the pop-up dialog.
|
|
:Example:</p>
|
|
<blockquote>
|
|
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">int_f</span> <span class="o">=</span> <span class="n">IntegerField</span><span class="p">(</span><span class="s2">"Specify Integer"</span><span class="p">)</span>
|
|
<span class="gp">>>> </span><span class="n">tex_f</span> <span class="o">=</span> <span class="n">TextLineField</span><span class="p">(</span><span class="s2">"Specify name"</span><span class="p">)</span>
|
|
<span class="gp">>>> </span><span class="n">choice_f</span> <span class="o">=</span> <span class="n">ChoiceField</span><span class="p">(</span><span class="s2">"Options"</span><span class="p">,</span> <span class="p">[</span><span class="s2">"Yes"</span><span class="p">,</span> <span class="s2">"No"</span><span class="p">,</span> <span class="s2">"Maybe"</span><span class="p">])</span>
|
|
<span class="gp">>>> </span><span class="n">get_form_input</span><span class="p">([</span><span class="s2">"Get Data"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">int_f</span><span class="p">,</span> <span class="n">tex_f</span><span class="p">,</span> <span class="n">choice_f</span><span class="p">],</span> <span class="s2">"The options"</span><span class="p">)</span>
|
|
<span class="go">Get Data</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Specify Integer 1337
|
|
Specify name Peter
|
|
The options
|
|
1) Yes
|
|
2) No
|
|
3) Maybe
|
|
Options 1
|
|
>>> True
|
|
>>> print(tex_f.result, int_f.result, choice_f.result)
|
|
Peter 1337 0</p>
|
|
</div></blockquote>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="binaryninja.interaction.get_int_input.html" class="btn btn-neutral float-right" title="binaryninja.interaction.get_int_input" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="binaryninja.interaction.get_directory_name_input.html" class="btn btn-neutral" title="binaryninja.interaction.get_directory_name_input" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2015-2019, Vector 35 Inc.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |