<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/> <title>steghide: BinaryIO 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="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 style="padding-left: 0.5em;"> <div id="projectname">steghide  <span id="projectnumber">0.5.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> | <a href="classBinaryIO-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">BinaryIO Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>provides methods for file i/o as needed by the rest of steghide </p> <p><code>#include <<a class="el" href="BinaryIO_8h_source.html">BinaryIO.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a39efef0fa56b45a901763f0f9d1515f8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> { <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8aab09be55cd7e94f751c2e7fabb33608a">READ</a>, <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8a58e070ce9ef4f5b02b7f65a7326b22d2">WRITE</a> }</td></tr> <tr class="separator:a39efef0fa56b45a901763f0f9d1515f8"><td class="memSeparator" colspan="2"> </td></tr> </table><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:a0bf35fbb43ff17d5b0a29bd492acd209"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a0bf35fbb43ff17d5b0a29bd492acd209">BinaryIO</a> (void)</td></tr> <tr class="separator:a0bf35fbb43ff17d5b0a29bd492acd209"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7ccae332f41b5437506d6cb58e0e6309"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a7ccae332f41b5437506d6cb58e0e6309">BinaryIO</a> (const std::string &fn, <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> m)</td></tr> <tr class="separator:a7ccae332f41b5437506d6cb58e0e6309"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a998ac3108e4a6a0bbb97b6488b85d279"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a998ac3108e4a6a0bbb97b6488b85d279">~BinaryIO</a> (void)</td></tr> <tr class="separator:a998ac3108e4a6a0bbb97b6488b85d279"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8ab6e9850dcb714109109a25f0c0e7c7"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a8ab6e9850dcb714109109a25f0c0e7c7">getName</a> (void) const </td></tr> <tr class="separator:a8ab6e9850dcb714109109a25f0c0e7c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4c87ded8bf158398e7d21e67d832e53f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a4c87ded8bf158398e7d21e67d832e53f">is_open</a> (void) const </td></tr> <tr class="separator:a4c87ded8bf158398e7d21e67d832e53f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9212f65a9caf82e40a43c894ef059f39"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a9212f65a9caf82e40a43c894ef059f39">is_std</a> (void) const </td></tr> <tr class="separator:a9212f65a9caf82e40a43c894ef059f39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a78799aa0941aafda8f42ee23050c5462"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a78799aa0941aafda8f42ee23050c5462">getPos</a> (void) const </td></tr> <tr class="separator:a78799aa0941aafda8f42ee23050c5462"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa9b7b67505fa2533f9750cabad423e34"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#aa9b7b67505fa2533f9750cabad423e34">eof</a> (void) const </td></tr> <tr class="separator:aa9b7b67505fa2533f9750cabad423e34"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a789dc643814786b49bdd0ab0484b7218"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a789dc643814786b49bdd0ab0484b7218">open</a> (const std::string &fn, <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> m)</td></tr> <tr class="separator:a789dc643814786b49bdd0ab0484b7218"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7d1b96a2c17fb45e7918e6d730861d04"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a7d1b96a2c17fb45e7918e6d730861d04">close</a> (void)</td></tr> <tr class="separator:a7d1b96a2c17fb45e7918e6d730861d04"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a23502610cfdf0d789dc02ef16262dbe1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a23502610cfdf0d789dc02ef16262dbe1">read8</a> (void)</td></tr> <tr class="separator:a23502610cfdf0d789dc02ef16262dbe1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9af2449937a4c50c638be6c03815a0cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a9af2449937a4c50c638be6c03815a0cf">read16_le</a> (void)</td></tr> <tr class="separator:a9af2449937a4c50c638be6c03815a0cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae6cab3a9995c04305f22e716ba20c332"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ae6cab3a9995c04305f22e716ba20c332">read16_be</a> (void)</td></tr> <tr class="separator:ae6cab3a9995c04305f22e716ba20c332"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41541700c43a89efd9a4e73bc0cb7bb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a41541700c43a89efd9a4e73bc0cb7bb7">read32_le</a> (void)</td></tr> <tr class="separator:a41541700c43a89efd9a4e73bc0cb7bb7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5f48a7aacb83a7381d9ce67f49d3a36c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a5f48a7aacb83a7381d9ce67f49d3a36c">read32_be</a> (void)</td></tr> <tr class="separator:a5f48a7aacb83a7381d9ce67f49d3a36c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a320263cd4adaee51b1ae982bdb3b6615"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a320263cd4adaee51b1ae982bdb3b6615">read_le</a> (unsigned short n)</td></tr> <tr class="separator:a320263cd4adaee51b1ae982bdb3b6615"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02f7eaa184af4082dd438a5fcd2c318b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a02f7eaa184af4082dd438a5fcd2c318b">readstring</a> (unsigned int len)</td></tr> <tr class="separator:a02f7eaa184af4082dd438a5fcd2c318b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3df966cbb5955a9cc12db9c1b841f316"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a3df966cbb5955a9cc12db9c1b841f316">write8</a> (<a class="el" href="common_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> val)</td></tr> <tr class="separator:a3df966cbb5955a9cc12db9c1b841f316"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af029be6769535da614986f3625d24c60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#af029be6769535da614986f3625d24c60">write16_le</a> (<a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> val)</td></tr> <tr class="separator:af029be6769535da614986f3625d24c60"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac551a0c15a8027b830d461df36c70982"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ac551a0c15a8027b830d461df36c70982">write16_be</a> (<a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> val)</td></tr> <tr class="separator:ac551a0c15a8027b830d461df36c70982"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a546779c9f2bd7a3bce516310605cfbb0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a546779c9f2bd7a3bce516310605cfbb0">write32_le</a> (<a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> val)</td></tr> <tr class="separator:a546779c9f2bd7a3bce516310605cfbb0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a778cb8560b7792e96a8de7a32440e2fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a778cb8560b7792e96a8de7a32440e2fe">write32_be</a> (<a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> val)</td></tr> <tr class="separator:a778cb8560b7792e96a8de7a32440e2fe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6d8356e8fbf862d79d8ec97fb93217c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a6d8356e8fbf862d79d8ec97fb93217c3">write_le</a> (<a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> val, unsigned short n)</td></tr> <tr class="separator:a6d8356e8fbf862d79d8ec97fb93217c3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a116ca944bd525917198f8438c9c2f1a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a116ca944bd525917198f8438c9c2f1a1">writestring</a> (const std::string &s)</td></tr> <tr class="separator:a116ca944bd525917198f8438c9c2f1a1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab6cfa014cda526271b4f993d3ece04c1"><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ab6cfa014cda526271b4f993d3ece04c1">getStream</a> (void) const </td></tr> <tr class="separator:ab6cfa014cda526271b4f993d3ece04c1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a54eb9e307df74443779107b2fe772bbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a54eb9e307df74443779107b2fe772bbf">setStream</a> (FILE *s)</td></tr> <tr class="separator:a54eb9e307df74443779107b2fe772bbf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9c866c14899279ad6e9fabb6b69767d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a9c866c14899279ad6e9fabb6b69767d5">setName</a> (const std::string &fn)</td></tr> <tr class="separator:a9c866c14899279ad6e9fabb6b69767d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88d1a37f7e836496761e4c6a672c3f1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#a88d1a37f7e836496761e4c6a672c3f1f">getMode</a> (void) const </td></tr> <tr class="separator:a88d1a37f7e836496761e4c6a672c3f1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abea111493f6008e396e4f99924912c7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#abea111493f6008e396e4f99924912c7b">setMode</a> (<a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> m)</td></tr> <tr class="separator:abea111493f6008e396e4f99924912c7b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a> Private Member Functions</h2></td></tr> <tr class="memitem:ae17f9a27379768a7403fde20b4b5f660"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ae17f9a27379768a7403fde20b4b5f660">init</a> (void)</td></tr> <tr class="separator:ae17f9a27379768a7403fde20b4b5f660"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aefffa46734a984085cd4309939bcaddb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#aefffa46734a984085cd4309939bcaddb">set_open</a> (bool o)</td></tr> <tr class="separator:aefffa46734a984085cd4309939bcaddb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae5c704413a2a9cab41df946da0f2946f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ae5c704413a2a9cab41df946da0f2946f">checkForce</a> (const std::string &fn) const </td></tr> <tr class="separator:ae5c704413a2a9cab41df946da0f2946f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab50c18790f0d3afeeecd787232a7a1de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ab50c18790f0d3afeeecd787232a7a1de">Fileexists</a> (const std::string &fn) const </td></tr> <tr class="separator:ab50c18790f0d3afeeecd787232a7a1de"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr class="memitem:aecedcd5d40e7b4326cd2ef3aa0e3c2ad"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#aecedcd5d40e7b4326cd2ef3aa0e3c2ad">Name</a></td></tr> <tr class="separator:aecedcd5d40e7b4326cd2ef3aa0e3c2ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa0009cff8318597b0c46a339d38f08ce"><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#aa0009cff8318597b0c46a339d38f08ce">Stream</a></td></tr> <tr class="separator:aa0009cff8318597b0c46a339d38f08ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9ae8526d944e3e26f50618afe09d3ab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#ac9ae8526d944e3e26f50618afe09d3ab">FileOpen</a></td></tr> <tr class="separator:ac9ae8526d944e3e26f50618afe09d3ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3305696bab79bc4e3b18ea6bfff4477"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryIO.html#aa3305696bab79bc4e3b18ea6bfff4477">Mode</a></td></tr> <tr class="separator:aa3305696bab79bc4e3b18ea6bfff4477"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="a39efef0fa56b45a901763f0f9d1515f8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">BinaryIO::MODE</a></td> </tr> </table> </div><div class="memdoc"> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a39efef0fa56b45a901763f0f9d1515f8aab09be55cd7e94f751c2e7fabb33608a"></a>READ</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a39efef0fa56b45a901763f0f9d1515f8a58e070ce9ef4f5b02b7f65a7326b22d2"></a>WRITE</em> </td><td class="fielddoc"> </td></tr> </table> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a0bf35fbb43ff17d5b0a29bd492acd209"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">BinaryIO::BinaryIO </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a7ccae332f41b5437506d6cb58e0e6309"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">BinaryIO::BinaryIO </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>fn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> </td> <td class="paramname"><em>m</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>construct a <a class="el" href="classBinaryIO.html" title="provides methods for file i/o as needed by the rest of steghide ">BinaryIO</a> object </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fn</td><td>the filename ("" to indicate stdin/stdout) </td></tr> <tr><td class="paramname">m</td><td>the mode (<a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8aab09be55cd7e94f751c2e7fabb33608a">BinaryIO::READ</a> or <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8a58e070ce9ef4f5b02b7f65a7326b22d2">BinaryIO::WRITE</a>)</td></tr> </table> </dd> </dl> <p>The file described by fn is opened in the given mode. </p> </div> </div> <a class="anchor" id="a998ac3108e4a6a0bbb97b6488b85d279"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">BinaryIO::~BinaryIO </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ae5c704413a2a9cab41df946da0f2946f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::checkForce </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>fn</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>when opening a file in write mode perform various checks depending on the value of the force argument </p> </div> </div> <a class="anchor" id="a7d1b96a2c17fb45e7918e6d730861d04"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::close </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>close the currently open file - it is save to call <a class="el" href="classBinaryIO.html#a7d1b96a2c17fb45e7918e6d730861d04">close()</a> even if <a class="el" href="classBinaryIO.html#a9212f65a9caf82e40a43c894ef059f39">is_std()</a> is true </p> </div> </div> <a class="anchor" id="aa9b7b67505fa2533f9750cabad423e34"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool BinaryIO::eof </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>is the current state of this file at the end of the file </p> </div> </div> <a class="anchor" id="ab50c18790f0d3afeeecd787232a7a1de"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool BinaryIO::Fileexists </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>fn</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>check if the file described by fn exists </p> <dl class="section return"><dt>Returns</dt><dd>true iff a fopen call with fn as file name succeeded </dd></dl> </div> </div> <a class="anchor" id="a88d1a37f7e836496761e4c6a672c3f1f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> BinaryIO::getMode </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a8ab6e9850dcb714109109a25f0c0e7c7"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const std::string& BinaryIO::getName </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the name (with path) of this file </p> </div> </div> <a class="anchor" id="a78799aa0941aafda8f42ee23050c5462"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long BinaryIO::getPos </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the current position in the current file </p> </div> </div> <a class="anchor" id="ab6cfa014cda526271b4f993d3ece04c1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">FILE* BinaryIO::getStream </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the underlying cstdio FILE* pointer </p> </div> </div> <a class="anchor" id="ae17f9a27379768a7403fde20b4b5f660"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::init </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a4c87ded8bf158398e7d21e67d832e53f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool BinaryIO::is_open </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>is this file currently opened ? </p> </div> </div> <a class="anchor" id="a9212f65a9caf82e40a43c894ef059f39"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool BinaryIO::is_std </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>is this file a standard stream (stdin or stdout) ? </p> </div> </div> <a class="anchor" id="a789dc643814786b49bdd0ab0484b7218"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::open </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>fn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> </td> <td class="paramname"><em>m</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>open the file given by fn in the mode m </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fn</td><td>a filename ("" to indicate stdin/stdout) </td></tr> <tr><td class="paramname">m</td><td>the mode (<a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8aab09be55cd7e94f751c2e7fabb33608a">BinaryIO::READ</a> or <a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8a58e070ce9ef4f5b02b7f65a7326b22d2">BinaryIO::WRITE</a>) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae6cab3a9995c04305f22e716ba20c332"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> BinaryIO::read16_be </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read two bytes from the file using big-endian byte ordering </p> </div> </div> <a class="anchor" id="a9af2449937a4c50c638be6c03815a0cf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> BinaryIO::read16_le </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read two bytes from the file using little-endian byte ordering </p> </div> </div> <a class="anchor" id="a5f48a7aacb83a7381d9ce67f49d3a36c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> BinaryIO::read32_be </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read four bytes from the file using big-endian byte ordering </p> </div> </div> <a class="anchor" id="a41541700c43a89efd9a4e73bc0cb7bb7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> BinaryIO::read32_le </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read four bytes from the file using little-endian byte ordering </p> </div> </div> <a class="anchor" id="a23502610cfdf0d789dc02ef16262dbe1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> BinaryIO::read8 </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read one byte from the file </p> </div> </div> <a class="anchor" id="a320263cd4adaee51b1ae982bdb3b6615"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> BinaryIO::read_le </td> <td>(</td> <td class="paramtype">unsigned short </td> <td class="paramname"><em>n</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read n bytes (little endian byte ordering) </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">n</td><td>the number of bytes to read (must be <= 4) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a02f7eaa184af4082dd438a5fcd2c318b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string BinaryIO::readstring </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>len</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>read a string with length len from the file </p> </div> </div> <a class="anchor" id="aefffa46734a984085cd4309939bcaddb"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::set_open </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>o</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="abea111493f6008e396e4f99924912c7b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::setMode </td> <td>(</td> <td class="paramtype"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> </td> <td class="paramname"><em>m</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a9c866c14899279ad6e9fabb6b69767d5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::setName </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>fn</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a54eb9e307df74443779107b2fe772bbf"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void BinaryIO::setStream </td> <td>(</td> <td class="paramtype">FILE * </td> <td class="paramname"><em>s</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ac551a0c15a8027b830d461df36c70982"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write16_be </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>write two bytes to the file using big-endian byte ordering </p> </div> </div> <a class="anchor" id="af029be6769535da614986f3625d24c60"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write16_le </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a9346f50cd1a0569efeb685f429a562ff">UWORD16</a> </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>write two bytes to the file using little-endian byte ordering </p> </div> </div> <a class="anchor" id="a778cb8560b7792e96a8de7a32440e2fe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write32_be </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>write four bytes to the file using big-endian byte ordering </p> </div> </div> <a class="anchor" id="a546779c9f2bd7a3bce516310605cfbb0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write32_le </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>write four bytes to the file using little-endian byte ordering </p> </div> </div> <a class="anchor" id="a3df966cbb5955a9cc12db9c1b841f316"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write8 </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>write one byte to the file </p> </div> </div> <a class="anchor" id="a6d8356e8fbf862d79d8ec97fb93217c3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::write_le </td> <td>(</td> <td class="paramtype"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td> <td class="paramname"><em>val</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned short </td> <td class="paramname"><em>n</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>write n bytes of val (little endian byte ordering) </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">n</td><td>the number of bytes to write (must be <= 4) </td></tr> <tr><td class="paramname">val</td><td>the value </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a116ca944bd525917198f8438c9c2f1a1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BinaryIO::writestring </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>s</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="ac9ae8526d944e3e26f50618afe09d3ab"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool BinaryIO::FileOpen</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aa3305696bab79bc4e3b18ea6bfff4477"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classBinaryIO.html#a39efef0fa56b45a901763f0f9d1515f8">MODE</a> BinaryIO::Mode</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aecedcd5d40e7b4326cd2ef3aa0e3c2ad"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string BinaryIO::Name</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aa0009cff8318597b0c46a339d38f08ce"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">FILE* BinaryIO::Stream</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="BinaryIO_8h_source.html">BinaryIO.h</a></li> <li><a class="el" href="BinaryIO_8cc.html">BinaryIO.cc</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 18 2013 17:59:37 for steghide by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>