<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: orcus::zip_archive Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>orcus</b></li><li class="navelem"><a class="el" href="classorcus_1_1zip__archive.html">zip_archive</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classorcus_1_1zip__archive-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::zip_archive Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a648597569fcf6ddcbaea757bf559bf1e"><td class="memItemLeft" align="right" valign="top"><a id="a648597569fcf6ddcbaea757bf559bf1e"></a>
 </td><td class="memItemRight" valign="bottom"><b>zip_archive</b> (<a class="el" href="classorcus_1_1zip__archive__stream.html">zip_archive_stream</a> *stream)</td></tr>
<tr class="separator:a648597569fcf6ddcbaea757bf559bf1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a146ab652b6f9eb866be5670773c247b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#a146ab652b6f9eb866be5670773c247b9">load</a> ()</td></tr>
<tr class="separator:a146ab652b6f9eb866be5670773c247b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a758c829ac16285c01b12fd9745db60d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#a758c829ac16285c01b12fd9745db60d5">dump_file_entry</a> (size_t index) const</td></tr>
<tr class="separator:a758c829ac16285c01b12fd9745db60d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93d221547d647fe4ae873ae066a18fa5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#a93d221547d647fe4ae873ae066a18fa5">dump_file_entry</a> (const char *entry_name) const</td></tr>
<tr class="separator:a93d221547d647fe4ae873ae066a18fa5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea35ebe0265e16649134f175ffc6401b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1pstring.html">pstring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#aea35ebe0265e16649134f175ffc6401b">get_file_entry_name</a> (size_t index) const</td></tr>
<tr class="separator:aea35ebe0265e16649134f175ffc6401b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f549d501105c5f65dee48dc611df6e9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#a6f549d501105c5f65dee48dc611df6e9">get_file_entry_count</a> () const</td></tr>
<tr class="separator:a6f549d501105c5f65dee48dc611df6e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8261d409c46564a39b82d295dd425864"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1zip__archive.html#a8261d409c46564a39b82d295dd425864">read_file_entry</a> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &entry_name, std::vector< unsigned char > &buf) const</td></tr>
<tr class="separator:a8261d409c46564a39b82d295dd425864"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a758c829ac16285c01b12fd9745db60d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a758c829ac16285c01b12fd9745db60d5">◆ </a></span>dump_file_entry() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::zip_archive::dump_file_entry </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump the content of a specified file entry to stdout.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>file entry index </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a93d221547d647fe4ae873ae066a18fa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93d221547d647fe4ae873ae066a18fa5">◆ </a></span>dump_file_entry() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::zip_archive::dump_file_entry </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>entry_name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump the content of a specified file entry to stdout.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry_name</td><td>file entry name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6f549d501105c5f65dee48dc611df6e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f549d501105c5f65dee48dc611df6e9">◆ </a></span>get_file_entry_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t orcus::zip_archive::get_file_entry_count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of file entries stored in this zip archive. Note that a file entry may be a directory, so the number of files stored in the zip archive may not equal the number of file entries.</p>
<dl class="section return"><dt>Returns</dt><dd>number of file entries. </dd></dl>
</div>
</div>
<a id="aea35ebe0265e16649134f175ffc6401b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea35ebe0265e16649134f175ffc6401b">◆ </a></span>get_file_entry_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1pstring.html">pstring</a> orcus::zip_archive::get_file_entry_name </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get file entry name from its index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>file entry index</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>file entry name </dd></dl>
</div>
</div>
<a id="a146ab652b6f9eb866be5670773c247b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a146ab652b6f9eb866be5670773c247b9">◆ </a></span>load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::zip_archive::load </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loading involves the parsing of the central directory of a zip archive (located toward the end of the stream) and building of file entry data which are stored in the central directory. </p>
</div>
</div>
<a id="a8261d409c46564a39b82d295dd425864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8261d409c46564a39b82d295dd425864">◆ </a></span>read_file_entry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool orcus::zip_archive::read_file_entry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">pstring</a> & </td>
<td class="paramname"><em>entry_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< unsigned char > & </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve data stream of specified file entry into buffer. The retrieved data stream gets uncompressed if the original stream is compressed. The method will overwrite the content of passed buffer if there is any pre-existing data in it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry_name</td><td>file entry name </td></tr>
<tr><td class="paramname">buf</td><td>buffer to put the retrieved data stream into.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:19 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
c5c5994443fc6b38a2708a666b93a6de
>
files
>
253
