Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 387

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::XMLStream 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.4.6 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    <li><a href="examples.html"><span>Examples</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 class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_x_m_l_stream.html">XMLStream</a></div>
<h1>ost::XMLStream Class Reference</h1><!-- doxytag: class="ost::XMLStream" -->This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.XML Stream Parser (SAX).  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="xml_8h-source.html">xml.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ost::XMLStream:
<p><center><img src="classost_1_1_x_m_l_stream.png" usemap="#ost::XMLStream_map" border="0" alt=""></center>
<map name="ost::XMLStream_map">
<area href="classost_1_1_x_m_l_r_p_c.html" alt="ost::XMLRPC" shape="rect" coords="0,56,100,80">
</map>
<a href="classost_1_1_x_m_l_stream-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#499e60e5b1b0e88d2f856e4bc8c63db8">open</a> (const char *resource)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">May perform an open operation on behalf of a parsed resource.  <a href="#499e60e5b1b0e88d2f856e4bc8c63db8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#5a581fb0b2875b0714a893837e2e5d11">close</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">May perform a close operation of an i/o source when the parser has completed operation.  <a href="#5a581fb0b2875b0714a893837e2e5d11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classost_1_1_slog.html#f139df7abeea150282dbbb29b4c24cee">Slog::Level</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#1981d1aa643f5aad965693c7a4132502">getLogging</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get error logging level.  <a href="#1981d1aa643f5aad965693c7a4132502"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#d0dce01d08f35d642960867c0f5ccfbd">comment</a> (const unsigned char *text, size_t len)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual to receive embedded comments in an XML document being parsed.  <a href="#d0dce01d08f35d642960867c0f5ccfbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#64e401b6b98c28523719d021f11acd52">read</a> (unsigned char *buffer, size_t len)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read method to aquire data for the parser.  <a href="#64e401b6b98c28523719d021f11acd52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#f0962a8d37d7a17d8aff75c9409bf72f">characters</a> (const unsigned char *text, size_t len)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual to receive character text extracted from the document in the current element.  <a href="#f0962a8d37d7a17d8aff75c9409bf72f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#4a4305dffd6b1eb7cdb6afd373fec8ef">startDocument</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identify start of document event.  <a href="#4a4305dffd6b1eb7cdb6afd373fec8ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#bc1e0f16c8100aadfde6acec56c2029e">endDocument</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identify end of document event.  <a href="#bc1e0f16c8100aadfde6acec56c2029e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a2ccb9652149b6e461902c102b8ccde6">startElement</a> (const unsigned char *name, const unsigned char **attr)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identify start of an element in the document.  <a href="#a2ccb9652149b6e461902c102b8ccde6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#74d63a5adf80d81d61888aad632f2b7d">endElement</a> (const unsigned char *name)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identify end of an element in the document.  <a href="#74d63a5adf80d81d61888aad632f2b7d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#98568a87c3d747583f8851f6d3f9fb1d">parse</a> (const char *resource=NULL)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse a resource as a stream thru the virtual read method.  <a href="#98568a87c3d747583f8851f6d3f9fb1d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#71e5d08fcb8ef8a5a91c7aec12111d32">~XMLStream</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.XML Stream Parser (SAX). 
<p>
This class must be derived into one that can impliment the physical I/O required to parse actual data. A mixer class using <a class="el" href="classost_1_1_x_m_l_stream.html">XMLStream</a> and <a class="el" href="classost_1_1_u_r_l_stream.html">URLStream</a> would seem a likely combination for this purpose.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>&gt; </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="xmlfetch_8cpp-example.html#_a96">xmlfetch.cpp</a>.</dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="71e5d08fcb8ef8a5a91c7aec12111d32"></a><!-- doxytag: member="ost::XMLStream::~XMLStream" ref="71e5d08fcb8ef8a5a91c7aec12111d32" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual ost::XMLStream::~XMLStream           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f0962a8d37d7a17d8aff75c9409bf72f"></a><!-- doxytag: member="ost::XMLStream::characters" ref="f0962a8d37d7a17d8aff75c9409bf72f" args="(const unsigned char *text, size_t len)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::characters           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>text</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap> <em>len</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Virtual to receive character text extracted from the document in the current element. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>received. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>length of text received. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a101">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="5a581fb0b2875b0714a893837e2e5d11"></a><!-- doxytag: member="ost::XMLStream::close" ref="5a581fb0b2875b0714a893837e2e5d11" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::close           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
May perform a close operation of an i/o source when the parser has completed operation. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="d0dce01d08f35d642960867c0f5ccfbd"></a><!-- doxytag: member="ost::XMLStream::comment" ref="d0dce01d08f35d642960867c0f5ccfbd" args="(const unsigned char *text, size_t len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::comment           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>text</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap> <em>len</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Virtual to receive embedded comments in an XML document being parsed. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>text comment extracted. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>length of comment. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a102">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="bc1e0f16c8100aadfde6acec56c2029e"></a><!-- doxytag: member="ost::XMLStream::endDocument" ref="bc1e0f16c8100aadfde6acec56c2029e" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::endDocument           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Identify end of document event. 
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a100">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="74d63a5adf80d81d61888aad632f2b7d"></a><!-- doxytag: member="ost::XMLStream::endElement" ref="74d63a5adf80d81d61888aad632f2b7d" args="(const unsigned char *name)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::endElement           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Identify end of an element in the document. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of element found. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a104">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="1981d1aa643f5aad965693c7a4132502"></a><!-- doxytag: member="ost::XMLStream::getLogging" ref="1981d1aa643f5aad965693c7a4132502" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual <a class="el" href="classost_1_1_slog.html#f139df7abeea150282dbbb29b4c24cee">Slog::Level</a> ost::XMLStream::getLogging           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get error logging level. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>error logging level. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="499e60e5b1b0e88d2f856e4bc8c63db8"></a><!-- doxytag: member="ost::XMLStream::open" ref="499e60e5b1b0e88d2f856e4bc8c63db8" args="(const char *resource)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual bool ost::XMLStream::open           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>resource</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
May perform an open operation on behalf of a parsed resource. 
<p>
In some cases, the parser may be merged with a class that already has performed some kind of open, and this method can then be ignored.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if open is successful. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>resource</em>&nbsp;</td><td>passed to Parse methods. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="98568a87c3d747583f8851f6d3f9fb1d"></a><!-- doxytag: member="ost::XMLStream::parse" ref="98568a87c3d747583f8851f6d3f9fb1d" args="(const char *resource=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool ost::XMLStream::parse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>resource</em> = <code>NULL</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parse a resource as a stream thru the virtual read method. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if well formed document has been fully parsed. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>resource</em>&nbsp;</td><td>optional name of resource. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="64e401b6b98c28523719d021f11acd52"></a><!-- doxytag: member="ost::XMLStream::read" ref="64e401b6b98c28523719d021f11acd52" args="(unsigned char *buffer, size_t len)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual int ost::XMLStream::read           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap> <em>len</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Read method to aquire data for the parser. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>to read data into. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>number of bytes to read. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a98">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="4a4305dffd6b1eb7cdb6afd373fec8ef"></a><!-- doxytag: member="ost::XMLStream::startDocument" ref="4a4305dffd6b1eb7cdb6afd373fec8ef" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::startDocument           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Identify start of document event. 
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a99">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<a class="anchor" name="a2ccb9652149b6e461902c102b8ccde6"></a><!-- doxytag: member="ost::XMLStream::startElement" ref="a2ccb9652149b6e461902c102b8ccde6" args="(const unsigned char *name, const unsigned char **attr)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::XMLStream::startElement           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const unsigned char **&nbsp;</td>
          <td class="mdname" nowrap> <em>attr</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Identify start of an element in the document. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of element found. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>attr</em>&nbsp;</td><td>list of attributes extracted. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmlfetch_8cpp-example.html#a103">xmlfetch.cpp</a>.</dl>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="xml_8h-source.html">xml.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:58 2006 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>