<!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"/> <title>id3lib: ID3_IStreamReader Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="id3lib.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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 class="tabs"> <ul> <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> <div class="contents"> <h1>ID3_IStreamReader Class Reference</h1><!-- doxytag: class="ID3_IStreamReader" --><!-- doxytag: inherits="ID3_Reader" --> <p><code>#include <<a class="el" href="readers_8h_source.html">readers.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ID3_IStreamReader:</div> <div class="dynsection"> <div class="center"> <img src="class_i_d3___i_stream_reader.png" usemap="#ID3_IStreamReader_map" alt=""/> <map id="ID3_IStreamReader_map" name="ID3_IStreamReader_map"> <area href="class_i_d3___reader.html" alt="ID3_Reader" shape="rect" coords="0,0,129,24"/> <area href="class_i_d3___i_f_stream_reader.html" alt="ID3_IFStreamReader" shape="rect" coords="0,112,129,136"/> </map> </div> </div> <p><a href="class_i_d3___i_stream_reader-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a9e7a987da828c3e68c200ad8734a57f9">ID3_IStreamReader</a> (istream &reader)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a103bf92404d004bf43640d8ea25c21da">~ID3_IStreamReader</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#aa9afe811196cc5f3195a04283508c0f4">close</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Close the reader. <a href="#aa9afe811196cc5f3195a04283508c0f4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">int_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a4f62667272a106f978414f57b0addbd7">peekChar</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the next character to be read without advancing the internal position. <a href="#a4f62667272a106f978414f57b0addbd7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a4a55e63a025be2476b882bef42681b9e">readChars</a> (char buf[], <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Read up to <code>len</code> chars into buf and advance the internal position accordingly. <a href="#a4a55e63a025be2476b882bef42681b9e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#abb918ea450bc65552e7e2f0009aaf03f">readChars</a> (<a class="el" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">char_type</a> buf[], <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Read up to <code>len</code> characters into buf and advance the internal position accordingly. <a href="#abb918ea450bc65552e7e2f0009aaf03f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a1c9f2552b6f25f2348dc04e4a283dc71">getBeg</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the beginning position in the reader. <a href="#a1c9f2552b6f25f2348dc04e4a283dc71"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#ac078db2a5d070087599ae5bf7417701e">getCur</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current position in the reader. <a href="#ac078db2a5d070087599ae5bf7417701e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a7ed8f110ac744ddb6b0a789b20df3548">getEnd</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ending position in the reader. <a href="#a7ed8f110ac744ddb6b0a789b20df3548"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#acf335334973e5a654125fcebdc129844">setCur</a> (<a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> pos)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the internal position for reading. <a href="#acf335334973e5a654125fcebdc129844"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___i_stream_reader.html#a78bc19b52a437d0096f53c2efc12ff20">getReader</a> () const </td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="readers_8h_source.html#l00034">34</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a9e7a987da828c3e68c200ad8734a57f9"></a><!-- doxytag: member="ID3_IStreamReader::ID3_IStreamReader" ref="a9e7a987da828c3e68c200ad8734a57f9" args="(istream &reader)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ID3_IStreamReader::ID3_IStreamReader </td> <td>(</td> <td class="paramtype">istream & </td> <td class="paramname"> <em>reader</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="readers_8h_source.html#l00040">40</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a103bf92404d004bf43640d8ea25c21da"></a><!-- doxytag: member="ID3_IStreamReader::~ID3_IStreamReader" ref="a103bf92404d004bf43640d8ea25c21da" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ID3_IStreamReader::~ID3_IStreamReader </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="readers_8h_source.html#l00041">41</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa9afe811196cc5f3195a04283508c0f4"></a><!-- doxytag: member="ID3_IStreamReader::close" ref="aa9afe811196cc5f3195a04283508c0f4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void ID3_IStreamReader::close </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Close the reader. </p> <p>Any further actions on the reader should fail. </p> <p>Implements <a class="el" href="class_i_d3___reader.html#af97817a1fa7ce41492d30df6b362b4c7">ID3_Reader</a>.</p> <p>Reimplemented in <a class="el" href="class_i_d3___i_f_stream_reader.html#a26b103da4bed0649b360d20ac5c2717d">ID3_IFStreamReader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00042">42</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a1c9f2552b6f25f2348dc04e4a283dc71"></a><!-- doxytag: member="ID3_IStreamReader::getBeg" ref="a1c9f2552b6f25f2348dc04e4a283dc71" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> ID3_IStreamReader::getBeg </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the beginning position in the reader. </p> <p>Reimplemented from <a class="el" href="class_i_d3___reader.html#aeaf468ffe03c08731dcaf268fff3391b">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00059">59</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="ac078db2a5d070087599ae5bf7417701e"></a><!-- doxytag: member="ID3_IStreamReader::getCur" ref="ac078db2a5d070087599ae5bf7417701e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> ID3_IStreamReader::getCur </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the current position in the reader. </p> <p>Implements <a class="el" href="class_i_d3___reader.html#a232935e138e44ea49e5a289fb8d7ac94">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00060">60</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a7ed8f110ac744ddb6b0a789b20df3548"></a><!-- doxytag: member="ID3_IStreamReader::getEnd" ref="a7ed8f110ac744ddb6b0a789b20df3548" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> ID3_IStreamReader::getEnd </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the ending position in the reader. </p> <p>Reimplemented from <a class="el" href="class_i_d3___reader.html#a5872b6813a652d831b770bfb7d65aec8">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00061">61</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a78bc19b52a437d0096f53c2efc12ff20"></a><!-- doxytag: member="ID3_IStreamReader::getReader" ref="a78bc19b52a437d0096f53c2efc12ff20" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">istream& ID3_IStreamReader::getReader </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="readers_8h_source.html#l00038">38</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a4f62667272a106f978414f57b0addbd7"></a><!-- doxytag: member="ID3_IStreamReader::peekChar" ref="a4f62667272a106f978414f57b0addbd7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#aa8b2afbb909ee02b838cde53113d1d8b">int_type</a> ID3_IStreamReader::peekChar </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the next character to be read without advancing the internal position. </p> <p>Returns END_OF_READER if there isn't a character to read. </p> <p>Implements <a class="el" href="class_i_d3___reader.html#af2b67659b76a3f28dac16e3522b552cf">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00044">44</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="abb918ea450bc65552e7e2f0009aaf03f"></a><!-- doxytag: member="ID3_IStreamReader::readChars" ref="abb918ea450bc65552e7e2f0009aaf03f" args="(char_type buf[], size_type len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> ID3_IStreamReader::readChars </td> <td>(</td> <td class="paramtype"><a class="el" href="class_i_d3___reader.html#abc80771e4ce81188082eaa8fa90a67e6">char_type</a> </td> <td class="paramname"> <em>buf</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> </td> <td class="paramname"> <em>len</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Read up to <code>len</code> characters into buf and advance the internal position accordingly. </p> <p>Returns the number of characters read into buf. Note that the value returned may be less than the number of bytes that the internal position advances, due to multi-byte characters. </p> <p>Implements <a class="el" href="class_i_d3___reader.html#a271015a0481e80ca63bfea9ff9320a50">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00053">53</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="a4a55e63a025be2476b882bef42681b9e"></a><!-- doxytag: member="ID3_IStreamReader::readChars" ref="a4a55e63a025be2476b882bef42681b9e" args="(char buf[], size_type len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> ID3_IStreamReader::readChars </td> <td>(</td> <td class="paramtype">char </td> <td class="paramname"> <em>buf</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_i_d3___reader.html#ab3891f70b4b079fe887e2eb707ca060e">size_type</a> </td> <td class="paramname"> <em>len</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Read up to <code>len</code> chars into buf and advance the internal position accordingly. </p> <p>Returns the number of characters read into buf. </p> <p>Reimplemented from <a class="el" href="class_i_d3___reader.html#a01bcb484f8188bb8efe8624b8e19d6b9">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00049">49</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <a class="anchor" id="acf335334973e5a654125fcebdc129844"></a><!-- doxytag: member="ID3_IStreamReader::setCur" ref="acf335334973e5a654125fcebdc129844" args="(pos_type pos)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> ID3_IStreamReader::setCur </td> <td>(</td> <td class="paramtype"><a class="el" href="class_i_d3___reader.html#a83194ea4d4e04e81302b095e9aa2275a">pos_type</a> </td> <td class="paramname"> <em>pos</em></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the value of the internal position for reading. </p> <p>Implements <a class="el" href="class_i_d3___reader.html#a1630f369cc7aa65a2279542715e9f483">ID3_Reader</a>.</p> <p>Definition at line <a class="el" href="readers_8h_source.html#l00072">72</a> of file <a class="el" href="readers_8h_source.html">readers.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/id3/<a class="el" href="readers_8h_source.html">readers.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jan 12 23:46:36 2011 for id3lib by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>