<!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_OStreamWriter 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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">id3lib <span id="projectnumber">3.8.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 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>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>ID3_OStreamWriter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ID3_OStreamWriter" --><!-- doxytag: inherits="ID3_Writer" -->
<p><code>#include <<a class="el" href="writers_8h_source.html">writers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ID3_OStreamWriter:</div>
<div class="dyncontent">
<div class="center">
<img src="class_i_d3___o_stream_writer.png" usemap="#ID3_OStreamWriter_map" alt=""/>
<map id="ID3_OStreamWriter_map" name="ID3_OStreamWriter_map">
<area href="class_i_d3___writer.html" alt="ID3_Writer" shape="rect" coords="0,0,129,24"/>
<area href="class_i_d3___o_f_stream_writer.html" alt="ID3_OFStreamWriter" shape="rect" coords="0,112,129,136"/>
</map>
</div></div>
<p><a href="class_i_d3___o_stream_writer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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___o_stream_writer.html#ac65d76c2a180d182e0b4e6db393c6cf2">ID3_OStreamWriter</a> (ostream &writer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#a4908977f4201c669603b5270ec1e927d">~ID3_OStreamWriter</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___o_stream_writer.html#a0ef4404ed21c6354f58998983bb0f9b0">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the writer. <a href="#a0ef4404ed21c6354f58998983bb0f9b0"></a><br/></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___o_stream_writer.html#afd39fd4aa12ac1f1b3ee0cc3d6c0df36">flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the writer. <a href="#afd39fd4aa12ac1f1b3ee0cc3d6c0df36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___writer.html#a2bc2a476eaf88ae5661bfb27f2a0a836">int_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#aebfc0503f0275742e1ca8b1e70aaf71b">writeChar</a> (<a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> ch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a single character and advance the internal position. <a href="#aebfc0503f0275742e1ca8b1e70aaf71b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#a97099a73a105924dd71f5428b04c8611">writeChars</a> (const char buf[], <a class="el" href="class_i_d3___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write up to <code>len</code> chars into buf and advance the internal position accordingly. <a href="#a97099a73a105924dd71f5428b04c8611"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#a04801198c242a9339e1f2fd6cb6716fd">writeChars</a> (const <a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> buf[], <a class="el" href="class_i_d3___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write up to <code>len</code> characters into buf and advance the internal position accordingly. <a href="#a04801198c242a9339e1f2fd6cb6716fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___writer.html#acc8ea5caeb95f604ab658d6ccd50b13c">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#ad15a0522dac6edb5a0a7357f670bd721">getBeg</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the beginning position in the writer. <a href="#ad15a0522dac6edb5a0a7357f670bd721"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___writer.html#acc8ea5caeb95f604ab658d6ccd50b13c">pos_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#ac799df5d76f9254a8ab10850bc2c8d3f">getCur</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the next position that will be written to. <a href="#ac799df5d76f9254a8ab10850bc2c8d3f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___o_stream_writer.html#a4ae1576529b61b528d2ddf5b14c15f93">getWriter</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="writers_8h_source.html#l00035">35</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac65d76c2a180d182e0b4e6db393c6cf2"></a><!-- doxytag: member="ID3_OStreamWriter::ID3_OStreamWriter" ref="ac65d76c2a180d182e0b4e6db393c6cf2" args="(ostream &writer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ID3_OStreamWriter::ID3_OStreamWriter </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"><em>writer</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="writers_8h_source.html#l00042">42</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4908977f4201c669603b5270ec1e927d"></a><!-- doxytag: member="ID3_OStreamWriter::~ID3_OStreamWriter" ref="a4908977f4201c669603b5270ec1e927d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ID3_OStreamWriter::~ID3_OStreamWriter </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="writers_8h_source.html#l00043">43</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0ef4404ed21c6354f58998983bb0f9b0"></a><!-- doxytag: member="ID3_OStreamWriter::close" ref="a0ef4404ed21c6354f58998983bb0f9b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_OStreamWriter::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 writer. </p>
<p>Any further actions on the writer should fail. </p>
<p>Implements <a class="el" href="class_i_d3___writer.html#a5c803392e90a229a5d386de43d833043">ID3_Writer</a>.</p>
<p>Reimplemented in <a class="el" href="class_i_d3___o_f_stream_writer.html#a0894b919d7af33ee411bc2d1ab9562cf">ID3_OFStreamWriter</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00045">45</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="afd39fd4aa12ac1f1b3ee0cc3d6c0df36"></a><!-- doxytag: member="ID3_OStreamWriter::flush" ref="afd39fd4aa12ac1f1b3ee0cc3d6c0df36" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_OStreamWriter::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flush the writer. </p>
<p>Implements <a class="el" href="class_i_d3___writer.html#ad93e96e4c66fe115606b5770eca5ec65">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00046">46</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad15a0522dac6edb5a0a7357f670bd721"></a><!-- doxytag: member="ID3_OStreamWriter::getBeg" ref="ad15a0522dac6edb5a0a7357f670bd721" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_i_d3___writer.html#acc8ea5caeb95f604ab658d6ccd50b13c">pos_type</a> ID3_OStreamWriter::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 writer. </p>
<p>Reimplemented from <a class="el" href="class_i_d3___writer.html#a7695d972b7c066f4684ffc1fa187d56a">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00068">68</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac799df5d76f9254a8ab10850bc2c8d3f"></a><!-- doxytag: member="ID3_OStreamWriter::getCur" ref="ac799df5d76f9254a8ab10850bc2c8d3f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_i_d3___writer.html#acc8ea5caeb95f604ab658d6ccd50b13c">pos_type</a> ID3_OStreamWriter::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 next position that will be written to. </p>
<p>Implements <a class="el" href="class_i_d3___writer.html#ab1e742def0bdb4d9f209537c1eff004e">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00069">69</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4ae1576529b61b528d2ddf5b14c15f93"></a><!-- doxytag: member="ID3_OStreamWriter::getWriter" ref="a4ae1576529b61b528d2ddf5b14c15f93" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ostream& ID3_OStreamWriter::getWriter </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="writers_8h_source.html#l00040">40</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebfc0503f0275742e1ca8b1e70aaf71b"></a><!-- doxytag: member="ID3_OStreamWriter::writeChar" ref="aebfc0503f0275742e1ca8b1e70aaf71b" args="(char_type ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_i_d3___writer.html#a2bc2a476eaf88ae5661bfb27f2a0a836">int_type</a> ID3_OStreamWriter::writeChar </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> </td>
<td class="paramname"><em>ch</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a single character and advance the internal position. </p>
<p>Note that the interal position may advance more than one byte for a single character write. Returns END_OF_WRITER if there isn't a character to write. </p>
<p>Reimplemented from <a class="el" href="class_i_d3___writer.html#a2fd7fda2100f38a45038b80de8ed4432">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00048">48</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a04801198c242a9339e1f2fd6cb6716fd"></a><!-- doxytag: member="ID3_OStreamWriter::writeChars" ref="a04801198c242a9339e1f2fd6cb6716fd" args="(const 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___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> ID3_OStreamWriter::writeChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">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___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write up to <code>len</code> characters into buf and advance the internal position accordingly. </p>
<p>Returns the number of characters write 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___writer.html#a287fd94f06b37fb638029b904e6f1d42">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00062">62</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a97099a73a105924dd71f5428b04c8611"></a><!-- doxytag: member="ID3_OStreamWriter::writeChars" ref="a97099a73a105924dd71f5428b04c8611" args="(const 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___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> ID3_OStreamWriter::writeChars </td>
<td>(</td>
<td class="paramtype">const 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___writer.html#afc6c0639631a72aca77af87de8bad947">size_type</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write up to <code>len</code> chars into buf and advance the internal position accordingly. </p>
<p>Returns the number of characters write into buf. </p>
<p>Reimplemented from <a class="el" href="class_i_d3___writer.html#ae9e686731d705c7f26c80160734a31fb">ID3_Writer</a>.</p>
<p>Definition at line <a class="el" href="writers_8h_source.html#l00057">57</a> of file <a class="el" href="writers_8h_source.html">writers.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="writers_8h_source.html">writers.h</a></li>
</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for id3lib by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address></body></html>
