doc/html/boost/dll/library_info.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class library_info</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../boost_dll/reference.html#header.boost.dll.library_info_hpp" title="Header &lt;boost/dll/library_info.hpp&gt;">
  10 <link rel="prev" href="../../BOOST_DLL_AUTO_ALIAS.html" title="Macro BOOST_DLL_AUTO_ALIAS">
  11 <link rel="next" href="symbol_location_ptr.html" title="Function symbol_location_ptr">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="../../BOOST_DLL_AUTO_ALIAS.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_dll/reference.html#header.boost.dll.library_info_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="symbol_location_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.dll.library_info"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class library_info</span></h2>
  30 <p>boost::dll::library_info &#8212; Class that is capable of extracting different information from a library or binary file. Currently understands ELF, MACH-O and PE formats on all the platforms. </p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_dll/reference.html#header.boost.dll.library_info_hpp" title="Header &lt;boost/dll/library_info.hpp&gt;">boost/dll/library_info.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="library_info.html" title="Class library_info">library_info</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">noncopyable</span> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="library_info.html#boost.dll.library_infoconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <span class="keyword">explicit</span> <a class="link" href="library_info.html#idp46836384-bb"><span class="identifier">library_info</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="library_info.html#idp46840048-bb"><span class="special">~</span><span class="identifier">library_info</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="library_info.html#idp46827200-bb">public member functions</a></span>
  43   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a class="link" href="library_info.html#idp46827760-bb"><span class="identifier">sections</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a class="link" href="library_info.html#idp46829488-bb"><span class="identifier">symbols</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a class="link" href="library_info.html#idp46831248-bb"><span class="identifier">symbols</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  46   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a class="link" href="library_info.html#idp46834128-bb"><span class="identifier">symbols</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47 <span class="special">}</span><span class="special">;</span></pre></div>
  48 <div class="refsect1">
  49 <a name="idp242401808"></a><h2>Description</h2>
  50 <div class="refsect2">
  51 <a name="idp242402224"></a><h3>
  52 <a name="boost.dll.library_infoconstruct-copy-destruct"></a><code class="computeroutput">library_info</code>
  53         public
  54        construct/copy/destruct</h3>
  55 <div class="orderedlist"><ol class="orderedlist" type="1">
  56 <li class="listitem">
  57 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp46836384-bb"></a><span class="identifier">library_info</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">&amp;</span> library_path<span class="special">,</span>
  58                       <span class="keyword">bool</span> throw_if_not_native_format <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre>
  59 <p>Opens file with specified path and prepares for information extraction.
  60 </p>
  61 <div class="variablelist"><table border="0" class="variablelist compact">
  62 <colgroup>
  63 <col align="left" valign="top">
  64 <col>
  65 </colgroup>
  66 <tbody><tr>
  67 <td><p><span class="term">Parameters:</span></p></td>
  68 <td><div class="variablelist"><table border="0" class="variablelist compact">
  69 <colgroup>
  70 <col align="left" valign="top">
  71 <col>
  72 </colgroup>
  73 <tbody>
  74 <tr>
  75 <td><p><span class="term"><code class="computeroutput">library_path</code></span></p></td>
  76 <td><p>Path to the binary file from which the info must be extracted. </p></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term"><code class="computeroutput">throw_if_not_native_format</code></span></p></td>
  80 <td><p>Throw an exception if this file format is not supported by OS. </p></td>
  81 </tr>
  82 </tbody>
  83 </table></div></td>
  84 </tr></tbody>
  85 </table></div>
  86 </li>
  87 <li class="listitem">
  88 <pre class="literallayout"><a name="idp46840048-bb"></a><span class="special">~</span><span class="identifier">library_info</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  89 <p>
  90 </p>
  91 <div class="variablelist"><table border="0" class="variablelist compact">
  92 <colgroup>
  93 <col align="left" valign="top">
  94 <col>
  95 </colgroup>
  96 <tbody><tr>
  97 <td><p><span class="term">Throws:</span></p></td>
  98 <td>Nothing. </td>
  99 </tr></tbody>
 100 </table></div>
 101 </li>
 102 </ol></div>
 103 </div>
 104 <div class="refsect2">
 105 <a name="idp242426240"></a><h3>
 106 <a name="idp46827200-bb"></a><code class="computeroutput">library_info</code> public member functions</h3>
 107 <div class="orderedlist"><ol class="orderedlist" type="1">
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a name="idp46827760-bb"></a><span class="identifier">sections</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 110 <p>
 111 </p>
 112 <div class="variablelist"><table border="0" class="variablelist compact">
 113 <colgroup>
 114 <col align="left" valign="top">
 115 <col>
 116 </colgroup>
 117 <tbody><tr>
 118 <td><p><span class="term">Returns:</span></p></td>
 119 <td><p>List of sections that exist in binary file. </p></td>
 120 </tr></tbody>
 121 </table></div>
 122 </li>
 123 <li class="listitem">
 124 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a name="idp46829488-bb"></a><span class="identifier">symbols</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 125 <p>
 126 </p>
 127 <div class="variablelist"><table border="0" class="variablelist compact">
 128 <colgroup>
 129 <col align="left" valign="top">
 130 <col>
 131 </colgroup>
 132 <tbody><tr>
 133 <td><p><span class="term">Returns:</span></p></td>
 134 <td><p>List of all the exportable symbols from all the sections that exist in binary file. </p></td>
 135 </tr></tbody>
 136 </table></div>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a name="idp46831248-bb"></a><span class="identifier">symbols</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> section_name<span class="special">)</span><span class="special">;</span></pre>
 140 <p>
 141
 142 </p>
 143 <div class="variablelist"><table border="0" class="variablelist compact">
 144 <colgroup>
 145 <col align="left" valign="top">
 146 <col>
 147 </colgroup>
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term">Parameters:</span></p></td>
 151 <td><div class="variablelist"><table border="0" class="variablelist compact">
 152 <colgroup>
 153 <col align="left" valign="top">
 154 <col>
 155 </colgroup>
 156 <tbody><tr>
 157 <td><p><span class="term"><code class="computeroutput">section_name</code></span></p></td>
 158 <td><p>Name of the section from which symbol names must be returned. </p></td>
 159 </tr></tbody>
 160 </table></div></td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term">Returns:</span></p></td>
 164 <td><p>List of symbols from the specified section. </p></td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 </li>
 169 <li class="listitem">
 170 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <a name="idp46834128-bb"></a><span class="identifier">symbols</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> section_name<span class="special">)</span><span class="special">;</span></pre>
 171 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 172 </li>
 173 </ol></div>
 174 </div>
 175 </div>
 176 </div>
 177 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 178 <td align="left"></td>
 179 <td align="right"><div class="copyright-footer">Copyright &#169; 2014 Renato Tegon Forti, Antony Polukhin<br>Copyright &#169; 2015 Antony Polukhin<br>Copyright &#169; 2016 Antony Polukhin, Klemens Morgenstern<p>
 180         Distributed under the Boost Software License, Version 1.0. (See accompanying
 181         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 182       </p>
 183 </div></td>
 184 </tr></table>
 185 <hr>
 186 <div class="spirit-nav">
 187 <a accesskey="p" href="../../BOOST_DLL_AUTO_ALIAS.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_dll/reference.html#header.boost.dll.library_info_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="symbol_location_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 188 </div>
 189 </body>
 190 </html>