Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 8ae7ec6813c5bf60cf058a6da524a0db > files > 63

id3lib-devel-3.8.3-25.fc15.i686.rpm

<!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_MemoryWriter 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&#160;<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&#160;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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<h1>ID3_MemoryWriter Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ID3_MemoryWriter" --><!-- doxytag: inherits="ID3_Writer" -->
<p><code>#include &lt;<a class="el" href="writers_8h_source.html">writers.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ID3_MemoryWriter:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_i_d3___memory_writer.png" usemap="#ID3_MemoryWriter_map" alt=""/>
  <map id="ID3_MemoryWriter_map" name="ID3_MemoryWriter_map">
<area href="class_i_d3___writer.html" alt="ID3_Writer" shape="rect" coords="0,0,118,24"/>
</map>
 </div></div>

<p><a href="class_i_d3___memory_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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#acd51fc96fb7d0c9ea4b4cea237b56b48">ID3_MemoryWriter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a4722814e9fe8163e85164470601a016c">ID3_MemoryWriter</a> (<a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> buf[], size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a3166e2f05105c5602793326c93353472">~ID3_MemoryWriter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a52fded1daf82744f3519c8ae8e6d482b">close</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the writer.  <a href="#a52fded1daf82744f3519c8ae8e6d482b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a780ebbe15ec78634adc9ee680473bf38">flush</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush the writer.  <a href="#a780ebbe15ec78634adc9ee680473bf38"></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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a3e5deb9f1d6ba91ca570e63e40a0689f">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">&#160;</td><td class="mdescRight">Write up to <code>len</code> chars from buf and advance the internal position accordingly.  <a href="#a3e5deb9f1d6ba91ca570e63e40a0689f"></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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#aac4822afca3f822251147d06d0e39462">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">&#160;</td><td class="mdescRight">Write up to <code>len</code> characters into buf and advance the internal position accordingly.  <a href="#aac4822afca3f822251147d06d0e39462"></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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a4e43f114e30af16ec4f2df329a2f6f67">getCur</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next position that will be written to.  <a href="#a4e43f114e30af16ec4f2df329a2f6f67"></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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a05bac39bf7ca46899f45f7e6a5565a22">getBeg</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the beginning position in the writer.  <a href="#a05bac39bf7ca46899f45f7e6a5565a22"></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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#a585f39babf7270632626ff511cfef3f6">getEnd</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the first position that can't be written to.  <a href="#a585f39babf7270632626ff511cfef3f6"></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">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___memory_writer.html#ac575935ba7c0aff028e0c3a7afd2cb19">setBuffer</a> (<a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> *buf, size_t size)</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#l00135">135</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acd51fc96fb7d0c9ea4b4cea237b56b48"></a><!-- doxytag: member="ID3_MemoryWriter::ID3_MemoryWriter" ref="acd51fc96fb7d0c9ea4b4cea237b56b48" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ID3_MemoryWriter::ID3_MemoryWriter </td>
          <td>(</td>
          <td class="paramname"></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#l00148">148</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4722814e9fe8163e85164470601a016c"></a><!-- doxytag: member="ID3_MemoryWriter::ID3_MemoryWriter" ref="a4722814e9fe8163e85164470601a016c" args="(char_type buf[], size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ID3_MemoryWriter::ID3_MemoryWriter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a>&#160;</td>
          <td class="paramname"><em>buf</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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#l00152">152</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3166e2f05105c5602793326c93353472"></a><!-- doxytag: member="ID3_MemoryWriter::~ID3_MemoryWriter" ref="a3166e2f05105c5602793326c93353472" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ID3_MemoryWriter::~ID3_MemoryWriter </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#l00156">156</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="a52fded1daf82744f3519c8ae8e6d482b"></a><!-- doxytag: member="ID3_MemoryWriter::close" ref="a52fded1daf82744f3519c8ae8e6d482b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ID3_MemoryWriter::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>Definition at line <a class="el" href="writers_8h_source.html#l00157">157</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a780ebbe15ec78634adc9ee680473bf38"></a><!-- doxytag: member="ID3_MemoryWriter::flush" ref="a780ebbe15ec78634adc9ee680473bf38" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ID3_MemoryWriter::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#l00158">158</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a05bac39bf7ca46899f45f7e6a5565a22"></a><!-- doxytag: member="ID3_MemoryWriter::getBeg" ref="a05bac39bf7ca46899f45f7e6a5565a22" 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_MemoryWriter::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#l00181">181</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4e43f114e30af16ec4f2df329a2f6f67"></a><!-- doxytag: member="ID3_MemoryWriter::getCur" ref="a4e43f114e30af16ec4f2df329a2f6f67" 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_MemoryWriter::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#l00176">176</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a585f39babf7270632626ff511cfef3f6"></a><!-- doxytag: member="ID3_MemoryWriter::getEnd" ref="a585f39babf7270632626ff511cfef3f6" 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_MemoryWriter::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 first position that can't be written to. </p>
<p>A return value of -1 indicates no (reasonable) limit to the writer. </p>

<p>Reimplemented from <a class="el" href="class_i_d3___writer.html#a54d6983dfa470242f826b4f791b916ac">ID3_Writer</a>.</p>

<p>Definition at line <a class="el" href="writers_8h_source.html#l00186">186</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac575935ba7c0aff028e0c3a7afd2cb19"></a><!-- doxytag: member="ID3_MemoryWriter::setBuffer" ref="ac575935ba7c0aff028e0c3a7afd2cb19" args="(char_type *buf, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ID3_MemoryWriter::setBuffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a> *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="writers_8h_source.html#l00141">141</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3e5deb9f1d6ba91ca570e63e40a0689f"></a><!-- doxytag: member="ID3_MemoryWriter::writeChars" ref="a3e5deb9f1d6ba91ca570e63e40a0689f" 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_MemoryWriter::writeChars </td>
          <td>(</td>
          <td class="paramtype">const char&#160;</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>&#160;</td>
          <td class="paramname"><em>len</em>&#160;</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 from buf and advance the internal position accordingly. </p>
<p>Returns the number of characters written from 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#l00163">163</a> of file <a class="el" href="writers_8h_source.html">writers.h</a>.</p>

</div>
</div>
<a class="anchor" id="aac4822afca3f822251147d06d0e39462"></a><!-- doxytag: member="ID3_MemoryWriter::writeChars" ref="aac4822afca3f822251147d06d0e39462" 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_MemoryWriter::writeChars </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_i_d3___writer.html#a994b16b0240f854ce6e50f58a93bae23">char_type</a>&#160;</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>&#160;</td>
          <td class="paramname"><em>len</em>&#160;</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#l00167">167</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&nbsp;<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>