binaryninja/commercial/api-docs/binaryninja.binaryview.BinaryReader.html

371 lines
22 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.binaryview.BinaryReader &mdash; Binary Ninja API 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
<link rel="top" title="Binary Ninja API 1.1.0 documentation" href="index.html"/>
<link rel="up" title="binaryview module" href="binaryninja.binaryview-module.html"/>
<link rel="next" title="binaryninja.binaryview.BinaryView" href="binaryninja.binaryview.BinaryView.html"/>
<link rel="prev" title="binaryninja.binaryview.BinaryDataNotificationCallbacks" href="binaryninja.binaryview.BinaryDataNotificationCallbacks.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">
1.1
</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.binaryninja-module.html">binaryninja</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.ActiveAnalysisInfo.html">binaryninja.binaryview.ActiveAnalysisInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.AddressRange.html">binaryninja.binaryview.AddressRange</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.AnalysisCompletionEvent.html">binaryninja.binaryview.AnalysisCompletionEvent</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.AnalysisInfo.html">binaryninja.binaryview.AnalysisInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.AnalysisProgress.html">binaryninja.binaryview.AnalysisProgress</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.BinaryDataNotification.html">binaryninja.binaryview.BinaryDataNotification</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.BinaryDataNotificationCallbacks.html">binaryninja.binaryview.BinaryDataNotificationCallbacks</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.binaryview.BinaryReader</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.BinaryView.html">binaryninja.binaryview.BinaryView</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.BinaryViewType.html">binaryninja.binaryview.BinaryViewType</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.BinaryWriter.html">binaryninja.binaryview.BinaryWriter</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.DataVariable.html">binaryninja.binaryview.DataVariable</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.Section.html">binaryninja.binaryview.Section</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.Segment.html">binaryninja.binaryview.Segment</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.StringReference.html">binaryninja.binaryview.StringReference</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.range.html">binaryninja.binaryview.range</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.binaryview.with_metaclass.html">binaryninja.binaryview.with_metaclass</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.builtins-module.html">builtins</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.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.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"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></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.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.pyopenssl-module.html">pyopenssl</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.requests-module.html">requests</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.setting-module.html">setting</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> &raquo;</li>
<li><a href="binaryninja.binaryview-module.html">binaryview module</a> &raquo;</li>
<li>binaryninja.binaryview.BinaryReader</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.binaryview.BinaryReader.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-binaryview-binaryreader">
<h1>binaryninja.binaryview.BinaryReader<a class="headerlink" href="#binaryninja-binaryview-binaryreader" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="binaryninja.binaryview.BinaryReader">
<em class="property">class </em><code class="descclassname">binaryninja.binaryview.</code><code class="descname">BinaryReader</code><span class="sig-paren">(</span><em>view</em>, <em>endian=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/binaryview.html#BinaryReader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.binaryview.BinaryReader" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal"><span class="pre">class</span> <span class="pre">BinaryReader</span></code> is a convenience class for reading binary data.</p>
<p>BinaryReader can be instantiated as follows and the rest of the document will start from this context</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">binaryninja</span> <span class="k">import</span> <span class="o">*</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">bv</span> <span class="o">=</span> <span class="n">BinaryViewType</span><span class="p">[</span><span class="s1">&#39;Mach-O&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;/bin/ls&quot;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">br</span> <span class="o">=</span> <span class="n">BinaryReader</span><span class="p">(</span><span class="n">bv</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">hex</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">read32</span><span class="p">())</span>
<span class="go">&#39;0xfeedfacfL&#39;</span>
<span class="go">&gt;&gt;&gt;</span>
</pre></div>
</div>
<p>Or using the optional endian parameter</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">binaryninja</span> <span class="k">import</span> <span class="o">*</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">br</span> <span class="o">=</span> <span class="n">BinaryReader</span><span class="p">(</span><span class="n">bv</span><span class="p">,</span> <span class="n">Endianness</span><span class="o">.</span><span class="n">BigEndian</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">hex</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">read32</span><span class="p">())</span>
<span class="go">&#39;0xcffaedfeL&#39;</span>
<span class="go">&gt;&gt;&gt;</span>
</pre></div>
</div>
<dl class="method">
<dt id="binaryninja.binaryview.BinaryReader.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>view</em>, <em>endian=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/binaryview.html#BinaryReader.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.binaryview.BinaryReader.__init__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#binaryninja.binaryview.BinaryReader.__init__" title="binaryninja.binaryview.BinaryReader.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a>(view[,&nbsp;endian])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read" title="binaryninja.binaryview.BinaryReader.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>(length)</td>
<td><code class="docutils literal"><span class="pre">read</span></code> returns <code class="docutils literal"><span class="pre">length</span></code> bytes read from the current offset, adding <code class="docutils literal"><span class="pre">length</span></code> to offset.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read16" title="binaryninja.binaryview.BinaryReader.read16"><code class="xref py py-obj docutils literal"><span class="pre">read16</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read16</span></code> returns a two byte integer from offet incrementing the offset by two, using specified endianness.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read16be" title="binaryninja.binaryview.BinaryReader.read16be"><code class="xref py py-obj docutils literal"><span class="pre">read16be</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read16be</span></code> returns a two byte big endian integer from offet incrementing the offset by two.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read16le" title="binaryninja.binaryview.BinaryReader.read16le"><code class="xref py py-obj docutils literal"><span class="pre">read16le</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read16le</span></code> returns a two byte little endian integer from offet incrementing the offset by two.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read32" title="binaryninja.binaryview.BinaryReader.read32"><code class="xref py py-obj docutils literal"><span class="pre">read32</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read32</span></code> returns a four byte integer from offet incrementing the offset by four, using specified endianness.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read32be" title="binaryninja.binaryview.BinaryReader.read32be"><code class="xref py py-obj docutils literal"><span class="pre">read32be</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read32be</span></code> returns a four byte big endian integer from offet incrementing the offset by four.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read32le" title="binaryninja.binaryview.BinaryReader.read32le"><code class="xref py py-obj docutils literal"><span class="pre">read32le</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read32le</span></code> returns a four byte little endian integer from offet incrementing the offset by four.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read64" title="binaryninja.binaryview.BinaryReader.read64"><code class="xref py py-obj docutils literal"><span class="pre">read64</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read64</span></code> returns an eight byte integer from offet incrementing the offset by eight, using specified endianness.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read64be" title="binaryninja.binaryview.BinaryReader.read64be"><code class="xref py py-obj docutils literal"><span class="pre">read64be</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read64be</span></code> returns an eight byte big endian integer from offet incrementing the offset by eight.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read64le" title="binaryninja.binaryview.BinaryReader.read64le"><code class="xref py py-obj docutils literal"><span class="pre">read64le</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read64le</span></code> returns an eight byte little endian integer from offet incrementing the offset by eight.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.read8" title="binaryninja.binaryview.BinaryReader.read8"><code class="xref py py-obj docutils literal"><span class="pre">read8</span></code></a>()</td>
<td><code class="docutils literal"><span class="pre">read8</span></code> returns a one byte integer from offet incrementing the offset.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.seek" title="binaryninja.binaryview.BinaryReader.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(offset)</td>
<td><code class="docutils literal"><span class="pre">seek</span></code> update internal offset to <code class="docutils literal"><span class="pre">offset</span></code>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.seek_relative" title="binaryninja.binaryview.BinaryReader.seek_relative"><code class="xref py py-obj docutils literal"><span class="pre">seek_relative</span></code></a>(offset)</td>
<td><code class="docutils literal"><span class="pre">seek_relative</span></code> updates the internal offset by <code class="docutils literal"><span class="pre">offset</span></code>.</td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.endianness" title="binaryninja.binaryview.BinaryReader.endianness"><code class="xref py py-obj docutils literal"><span class="pre">endianness</span></code></a></td>
<td>The Endianness to read data.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.eof" title="binaryninja.binaryview.BinaryReader.eof"><code class="xref py py-obj docutils literal"><span class="pre">eof</span></code></a></td>
<td>Is end of file (read-only)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.binaryview-module.html#binaryninja.binaryview.BinaryReader.offset" title="binaryninja.binaryview.BinaryReader.offset"><code class="xref py py-obj docutils literal"><span class="pre">offset</span></code></a></td>
<td>The current read offset (read/write).</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.binaryview.BinaryView.html" class="btn btn-neutral float-right" title="binaryninja.binaryview.BinaryView" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.binaryview.BinaryDataNotificationCallbacks.html" class="btn btn-neutral" title="binaryninja.binaryview.BinaryDataNotificationCallbacks" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, Vector 35 LLC.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>