diff options
Diffstat (limited to 'db/docs/api_cxx/xmlresults_class.html')
| -rw-r--r-- | db/docs/api_cxx/xmlresults_class.html | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/db/docs/api_cxx/xmlresults_class.html b/db/docs/api_cxx/xmlresults_class.html new file mode 100644 index 000000000..3e7d95b3e --- /dev/null +++ b/db/docs/api_cxx/xmlresults_class.html @@ -0,0 +1,79 @@ +<!--Id: xmlresults_class.so,v 1.8 2002/07/29 04:20:27 mjc Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: XmlResults</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> +<a name="2"><!--meow--></a> +<table width="100%"><tr valign=top> +<td> +<h1>XmlResults</h1> +</td> +<td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <DbXml.hpp> +<p> +class DbXml::XmlResults { +public: + XmlResults(const XmlResults &); + ~XmlResults(); + XmlResults &operator = (const XmlResults &) + ... +}; +</pre></h3> +<h1>Description</h1> +<p>The XmlResults class encapsulates the results of a query against +an <a href="../api_cxx/xmlcontainer_class.html">XmlContainer</a>. +<p>The results of a query are a collection of <a href="../api_cxx/xmlvalue_class.html">XmlValue</a>s. The +<a href="../api_cxx/xmlvalue_class.html">XmlValue</a>s may be either documents or nodesets. If the query +context selected a return type of <a href="../api_cxx/xmlq_setret.html#XmlQueryContext::ResultValues">XmlQueryContext::ResultValues</a> +then the values will be of type NodeListValue, otherwise they will be +of type DocumentValue. +<p>An XmlResults object is created by calling <a href="../api_cxx/xml_xpath.html">XmlContainer::queryWithXPath</a>. +If the query context called for lazy expression evaluation then the +resultant values will be computed as needed. If eager evaluation was +selected the resultant values are stored within the XmlResults +object. +<p>XmlResults provides an iteration interface through its next() +method. When there are no more values available the passed back value +pointer will be zero. If eager evaluation was selected then the reset +method can be called to reset the iterator, and the next call to next() +will return the first value of the results. +<h1>Class</h1> +<a href="../api_cxx/xmlcontainer_class.html">XmlContainer</a>, <a href="../api_cxx/xmldocument_class.html">XmlDocument</a>, <a href="../api_cxx/xmlquery_class.html">XmlQueryContext</a> +<h1>See Also</h1> +<a href="../api_cxx/xml_close.html">XmlContainer::close</a>, +<a href="../api_cxx/xml_declare.html">XmlContainer::declareIndex</a>, +<a href="../api_cxx/xml_del.html">XmlContainer::deleteDocument</a>, +<a href="../api_cxx/xml_get.html">XmlContainer::getDocument</a>, +<a href="../api_cxx/xml_getname.html">XmlContainer::getName</a>, +<a href="../api_cxx/xml_open.html">XmlContainer::open</a>, +<a href="../api_cxx/xml_put.html">XmlContainer::putDocument</a> +and +<a href="../api_cxx/xml_xpath.html">XmlContainer::queryWithXPath</a>. +<p> +<a href="../api_cxx/xmldoc_getattr.html">XmlDocument::getAttributeValue</a>, +<a href="../api_cxx/xmldoc_getcont.html">XmlDocument::getContent</a>, +<a href="../api_cxx/xmldoc_getid.html">XmlDocument::getID</a>, +<a href="../api_cxx/xmldoc_getname.html">XmlDocument::getName</a>, +<a href="../api_cxx/xmldoc_gettype.html">XmlDocument::getType</a>, +<a href="../api_cxx/xmldoc_setcont.html">XmlDocument::setContent</a>, +<a href="../api_cxx/xmldoc_setname.html">XmlDocument::setName</a>, +and +<a href="../api_cxx/xmldoc_settype.html">XmlDocument::setType</a>. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> |