Sophie

Sophie

distrib > Mandriva > current > i586 > media > contrib-release > by-pkgid > 59e136c5713357bec32fa00e9f43af8f > files > 417

xerces-c-doc-3.1.0-2mdv2010.1.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: BinMemInputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li class="current"><a href="classes.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="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>BinMemInputStream Class Reference</h1><!-- doxytag: class="BinMemInputStream" --><!-- doxytag: inherits="BinInputStream" --><div class="dynheader">
Inheritance diagram for BinMemInputStream:</div>
<div class="dynsection">

<p><center><img src="classBinMemInputStream.png" usemap="#BinMemInputStream_map" border="0" alt=""></center>
<map name="BinMemInputStream_map">
<area href="classBinInputStream.html" alt="BinInputStream" shape="rect" coords="0,56,123,80">
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="0,0,123,24">
</map>
</div>

<p>
<a href="classBinMemInputStream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a> { <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d">BufOpt_Adopt</a>, 
<a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a">BufOpt_Copy</a>, 
<a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b">BufOpt_Reference</a>
 }</td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#7ce2673aed61cb2c053f2a14b7ad276a">BinMemInputStream</a> (const <a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const initData, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> capacity, const <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a> bufOpt=BufOpt_Copy, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#9923322cccd88acb966b93ae804490dd">~BinMemInputStream</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#071b3c5877e19a8191f59e6c69d271fc">reset</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#16de7f8cb3aa38ad7233fb310c63929d">curPos</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#fe5316fc9aa18d3cd581f016fbdbda7c">readBytes</a> (<a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxToRead)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#43ef21224f83f5c76c18d10dfb147d7b">getContentType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification.  <a href="#43ef21224f83f5c76c18d10dfb147d7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#ae9e8521d07aaf5a12efbea97c969938">getSize</a> () const </td></tr>

</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69"></a><!-- doxytag: member="BinMemInputStream::BufOpts" ref="939fb86f3143d1857e1134ad4d73bc69" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BinMemInputStream::BufOpts</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d"></a><!-- doxytag: member="BufOpt_Adopt" ref="939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d" args="" -->BufOpt_Adopt</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a"></a><!-- doxytag: member="BufOpt_Copy" ref="939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a" args="" -->BufOpt_Copy</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b"></a><!-- doxytag: member="BufOpt_Reference" ref="939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b" args="" -->BufOpt_Reference</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7ce2673aed61cb2c053f2a14b7ad276a"></a><!-- doxytag: member="BinMemInputStream::BinMemInputStream" ref="7ce2673aed61cb2c053f2a14b7ad276a" args="(const XMLByte *const initData, const XMLSize_t capacity, const BufOpts bufOpt=BufOpt_Copy, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">BinMemInputStream::BinMemInputStream           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const &nbsp;</td>
          <td class="paramname"> <em>initData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td>
          <td class="paramname"> <em>capacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a>&nbsp;</td>
          <td class="paramname"> <em>bufOpt</em> = <code>BufOpt_Copy</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
          <td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="9923322cccd88acb966b93ae804490dd"></a><!-- doxytag: member="BinMemInputStream::~BinMemInputStream" ref="9923322cccd88acb966b93ae804490dd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual BinMemInputStream::~BinMemInputStream           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="071b3c5877e19a8191f59e6c69d271fc"></a><!-- doxytag: member="BinMemInputStream::reset" ref="071b3c5877e19a8191f59e6c69d271fc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BinMemInputStream::reset           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="16de7f8cb3aa38ad7233fb310c63929d"></a><!-- doxytag: member="BinMemInputStream::curPos" ref="16de7f8cb3aa38ad7233fb310c63929d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinMemInputStream::curPos           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Implements <a class="el" href="classBinInputStream.html#959a030c22785e3bcee6e7dd6800df71">BinInputStream</a>.</p>

</div>
</div><p>
<a class="anchor" name="fe5316fc9aa18d3cd581f016fbdbda7c"></a><!-- doxytag: member="BinMemInputStream::readBytes" ref="fe5316fc9aa18d3cd581f016fbdbda7c" args="(XMLByte *const toFill, const XMLSize_t maxToRead)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinMemInputStream::readBytes           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const &nbsp;</td>
          <td class="paramname"> <em>toFill</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td>
          <td class="paramname"> <em>maxToRead</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Implements <a class="el" href="classBinInputStream.html#2245666a5058c666d0238ea5e5b5334b">BinInputStream</a>.</p>

</div>
</div><p>
<a class="anchor" name="43ef21224f83f5c76c18d10dfb147d7b"></a><!-- doxytag: member="BinMemInputStream::getContentType" ref="43ef21224f83f5c76c18d10dfb147d7b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a>* BinMemInputStream::getContentType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification. 
<p>
If no such content type is provided for the data, 0 is returned. This function is expected to return the correct value at any time after the construction of the stream.<p>
An example of the stream that may return non-0 from this function is an HTTP stream with the value returned taken from the "Content-Type" HTTP header. Note also that if the encoding of the data is known to the application by some other means then the setEncoding function in the <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> object should be used instead. The getContentType function should only be used to return information that is intrinsic to the stream.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The content type, or 0 if one is not available. </dd></dl>

<p>Implements <a class="el" href="classBinInputStream.html#cb658844f9600ad353604bc403e74ff4">BinInputStream</a>.</p>

</div>
</div><p>
<a class="anchor" name="ae9e8521d07aaf5a12efbea97c969938"></a><!-- doxytag: member="BinMemInputStream::getSize" ref="ae9e8521d07aaf5a12efbea97c969938" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinMemInputStream::getSize           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BinMemInputStream_8hpp-source.html">BinMemInputStream.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 29 15:30:48 2010 for Xerces-C++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>