<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ID3_IStreamReader class Reference</title> <link href="id3lib.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.12 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>ID3_IStreamReader Class Reference</h1><code>#include <<a class="el" href="readers_8h-source.html">readers.h</a>></code> <p> <p>Inheritance diagram for ID3_IStreamReader:: <p><center><img src="class_i_d3___i_stream_reader.gif" usemap="#ID3_IStreamReader_map" border="0"></center> <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> <a href="class_i_d3___i_stream_reader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a0">ID3_IStreamReader</a> (istream &reader)</td></tr> <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a1">~ID3_IStreamReader</a> ()</td></tr> <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a2">close</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Close the reader.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s4">int_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a3">peekChar</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Return the next character to be read without advancing the internal position.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s0">size_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a4">readChars</a> (char buf[], <a class="el" href="class_i_d3___reader.html#s0">size_type</a> len)</td></tr> <tr><td> </td><td><font size=-1><em>Read up to <code>len</code> chars into buf and advance the internal position accordingly.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s0">size_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a5">readChars</a> (<a class="el" href="class_i_d3___reader.html#s1">char_type</a> buf[], <a class="el" href="class_i_d3___reader.html#s0">size_type</a> len)</td></tr> <tr><td> </td><td><font size=-1><em>Read up to <code>len</code> characters into buf and advance the internal position accordingly.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a6">getBeg</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Return the beginning position in the reader.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a7">getCur</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Return the current position in the reader.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a8">getEnd</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Return the ending position in the reader.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#a9">setCur</a> (<a class="el" href="class_i_d3___reader.html#s2">pos_type</a> pos)</td></tr> <tr><td> </td><td><font size=-1><em>Set the value of the internal position for reading.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> <tr><td nowrap align=right valign=top>istream & </td><td valign=bottom><a class="el" href="class_i_d3___i_stream_reader.html#b0">getReader</a> () const</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="ID3_IStreamReader::ID3_IStreamReader"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ID3_IStreamReader::ID3_IStreamReader </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">istream & </td> <td class="mdname1" valign="top" nowrap> <em>reader</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <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>. </td> </tr> </table> <a name="a1" doxytag="ID3_IStreamReader::~ID3_IStreamReader"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual ID3_IStreamReader::~ID3_IStreamReader </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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>. </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a2" doxytag="ID3_IStreamReader::close"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void ID3_IStreamReader::close </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Close the reader. <p> Any further actions on the reader should fail. <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a0">ID3_Reader</a>. <p> Reimplemented in <a class="el" href="class_i_d3___i_f_stream_reader.html#a1">ID3_IFStreamReader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00043">43</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. </td> </tr> </table> <a name="a6" doxytag="ID3_IStreamReader::getBeg"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> ID3_IStreamReader::getBeg </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return the beginning position in the reader. <p> <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a1">ID3_Reader</a>. <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>. </td> </tr> </table> <a name="a7" doxytag="ID3_IStreamReader::getCur"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> ID3_IStreamReader::getCur </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return the current position in the reader. <p> <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a3">ID3_Reader</a>. <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>. </td> </tr> </table> <a name="a8" doxytag="ID3_IStreamReader::getEnd"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> ID3_IStreamReader::getEnd </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return the ending position in the reader. <p> <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a2">ID3_Reader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00062">62</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. <p> References <a class="el" href="class_i_d3___reader.html#a3">ID3_Reader::getCur</a>(), and <a class="el" href="class_i_d3___reader.html#a4">ID3_Reader::setCur</a>(). </td> </tr> </table> <a name="b0" doxytag="ID3_IStreamReader::getReader"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> istream& ID3_IStreamReader::getReader </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [inline, protected]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Definition at line <a class="el" href="readers_8h-source.html#l00039">39</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. </td> </tr> </table> <a name="a3" doxytag="ID3_IStreamReader::peekChar"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s4">int_type</a> ID3_IStreamReader::peekChar </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return the next character to be read without advancing the internal position. <p> Returns END_OF_READER if there isn't a character to read. <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a6">ID3_Reader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00045">45</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. </td> </tr> </table> <a name="a5" doxytag="ID3_IStreamReader::readChars"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s0">size_type</a> ID3_IStreamReader::readChars </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="class_i_d3___reader.html#s1">char_type</a> </td> <td class="mdname" nowrap> <em>buf</em>[], </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="class_i_d3___reader.html#s0">size_type</a> </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Read up to <code>len</code> characters into buf and advance the internal position accordingly. <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> Reimplemented from <a class="el" href="class_i_d3___reader.html#a7">ID3_Reader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00054">54</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. </td> </tr> </table> <a name="a4" doxytag="ID3_IStreamReader::readChars"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s0">size_type</a> ID3_IStreamReader::readChars </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char </td> <td class="mdname" nowrap> <em>buf</em>[], </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="class_i_d3___reader.html#s0">size_type</a> </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Read up to <code>len</code> chars into buf and advance the internal position accordingly. <p> Returns the number of characters read into buf. <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a8">ID3_Reader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00050">50</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. <p> References <a class="el" href="class_i_d3___reader.html#a7">ID3_Reader::readChars</a>(). </td> </tr> </table> <a name="a9" doxytag="ID3_IStreamReader::setCur"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="class_i_d3___reader.html#s2">pos_type</a> ID3_IStreamReader::setCur </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="class_i_d3___reader.html#s2">pos_type</a> </td> <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set the value of the internal position for reading. <p> <p> Reimplemented from <a class="el" href="class_i_d3___reader.html#a4">ID3_Reader</a>. <p> Definition at line <a class="el" href="readers_8h-source.html#l00073">73</a> of file <a class="el" href="readers_8h-source.html">readers.h</a>. </td> </tr> </table> <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></ul> <hr><address><small>Generated on Thu Jan 3 07:35:57 2002 for id3lib by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.12 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>