1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
<!--Id: xmldoc_getid.so,v 10.5 2002/06/24 14:49:39 bostic Exp -->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: XmlDocument::getID</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>XmlDocument::getID</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>
u_int32_t
XmlDocument::getID() const;
</pre></h3>
<h1>Description</h1>
<p>The XmlDocument::getID method returns the document ID. The document ID will
be zero if the document has not yet been assigned any content, or the
document has not yet been added to a container.
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
<p>The XmlDocument::getID method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The XmlDocument::getID method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>The document does not have an ID.
</dl>
<p>The XmlDocument::getID method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the XmlDocument::getID method may fail and
throw a <a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<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>
|
