doc/html/GUPnPXMLDoc.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GUPnPXMLDoc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GUPnP Reference Manual">
   8 <link rel="up" href="api-utility.html" title="Utility Functions">
   9 <link rel="prev" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory">
  10 <link rel="next" href="gupnp-Error-codes.html" title="Error codes">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GUPnPResourceFactory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="api-utility.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GUPnP Reference Manual</th>
  21 <td><a accesskey="n" href="gupnp-Error-codes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GUPnPXMLDoc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPXMLDoc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPXMLDoc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GUPnPXMLDoc"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GUPnPXMLDoc.top_of_page"></a>GUPnPXMLDoc</span></h2>
  36 <p>GUPnPXMLDoc — GObject wrapper for xmlDoc.</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GUPnPXMLDoc.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GUPnPXMLDoc.html#GUPnPXMLDoc-struct" title="struct GUPnPXMLDoc">GUPnPXMLDoc</a>;
  43 <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *       <a class="link" href="GUPnPXMLDoc.html#gupnp-xml-doc-new" title="gupnp_xml_doc_new ()">gupnp_xml_doc_new</a>                   (<em class="parameter"><code><span class="type">xmlDoc</span> *xml_doc</code></em>);
  44 <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *       <a class="link" href="GUPnPXMLDoc.html#gupnp-xml-doc-new-from-path" title="gupnp_xml_doc_new_from_path ()">gupnp_xml_doc_new_from_path</a>         (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  46 </pre>
  47 </div>
  48 <div class="refsect1">
  49 <a name="GUPnPXMLDoc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  50 <pre class="synopsis">
  51   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  52    +----GUPnPXMLDoc
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="GUPnPXMLDoc.description"></a><h2>Description</h2>
  57 <p>
  58 GObject wrapper for xmlDoc, so that we can use refcounting and weak
  59 references.
  60 </p>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GUPnPXMLDoc.details"></a><h2>Details</h2>
  64 <div class="refsect2">
  65 <a name="GUPnPXMLDoc-struct"></a><h3>struct GUPnPXMLDoc</h3>
  66 <pre class="programlisting">struct GUPnPXMLDoc {
  67         xmlDoc *doc;
  68 };
  69 </pre>
  70 <p>
  71 </p>
  72 </div>
  73 <hr>
  74 <div class="refsect2">
  75 <a name="gupnp-xml-doc-new"></a><h3>gupnp_xml_doc_new ()</h3>
  76 <pre class="programlisting"><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *       gupnp_xml_doc_new                   (<em class="parameter"><code><span class="type">xmlDoc</span> *xml_doc</code></em>);</pre>
  77 <p>
  78 Create a new <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a> for <em class="parameter"><code>xml_doc</code></em>.
  79 </p>
  80 <div class="variablelist"><table border="0">
  81 <col align="left" valign="top">
  82 <tbody>
  83 <tr>
  84 <td><p><span class="term"><em class="parameter"><code>xml_doc</code></em> :</span></p></td>
  85 <td>Pointer to <span class="type">xmlDoc</span> to wrap under this object</td>
  86 </tr>
  87 <tr>
  88 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  89 <td>A new <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on an error</td>
  90 </tr>
  91 </tbody>
  92 </table></div>
  93 </div>
  94 <hr>
  95 <div class="refsect2">
  96 <a name="gupnp-xml-doc-new-from-path"></a><h3>gupnp_xml_doc_new_from_path ()</h3>
  97 <pre class="programlisting"><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *       gupnp_xml_doc_new_from_path         (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
  98                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  99 <p>
 100 Create a new <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a> for the XML document at <em class="parameter"><code>path</code></em>.
 101 </p>
 102 <div class="variablelist"><table border="0">
 103 <col align="left" valign="top">
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
 107 <td>Path to xml document</td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 111 <td>Location to put the error into</td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 115 <td>A new <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on an error</td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 </div>
 120 </div>
 121 </div>
 122 <div class="footer">
 123 <hr>
 124           Generated by GTK-Doc V1.18</div>
 125 </body>
 126 </html>