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>GUPnP Reference Manual: GUPnPXMLDoc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.20 (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="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#GUPnPXMLDoc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#GUPnPXMLDoc.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="api-utility.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="GUPnPResourceFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gupnp-Error-codes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="GUPnPXMLDoc"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="GUPnPXMLDoc.top_of_page"></a>GUPnPXMLDoc</span></h2>
  31 <p>GUPnPXMLDoc — GObject wrapper for xmlDoc.</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="GUPnPXMLDoc.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="GUPnPXMLDoc.html#gupnp-xml-doc-new" title="gupnp_xml_doc_new ()">gupnp_xml_doc_new</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *
  54 </td>
  55 <td class="function_name">
  56 <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> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 </tbody>
  60 </table></div>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GUPnPXMLDoc.other"></a><h2>Types and Values</h2>
  64 <div class="informaltable"><table width="100%" border="0">
  65 <colgroup>
  66 <col width="150px" class="name">
  67 <col class="description">
  68 </colgroup>
  69 <tbody><tr>
  70 <td class="datatype_keyword">struct</td>
  71 <td class="function_name"><a class="link" href="GUPnPXMLDoc.html#GUPnPXMLDoc-struct" title="struct GUPnPXMLDoc">GUPnPXMLDoc</a></td>
  72 </tr></tbody>
  73 </table></div>
  74 </div>
  75 <div class="refsect1">
  76 <a name="GUPnPXMLDoc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  77 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  78     <span class="lineart">╰──</span> GUPnPXMLDoc
  79 </pre>
  80 </div>
  81 <div class="refsect1">
  82 <a name="GUPnPXMLDoc.description"></a><h2>Description</h2>
  83 <p>GObject wrapper for xmlDoc, so that we can use refcounting and weak
  84 references.</p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GUPnPXMLDoc.functions_details"></a><h2>Functions</h2>
  88 <div class="refsect2">
  89 <a name="gupnp-xml-doc-new"></a><h3>gupnp_xml_doc_new ()</h3>
  90 <pre class="programlisting"><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *
  91 gupnp_xml_doc_new (<em class="parameter"><code><span class="type">xmlDoc</span> *xml_doc</code></em>);</pre>
  92 <p>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>
  93 .</p>
  94 <div class="refsect3">
  95 <a name="id-1.3.6.5.7.2.5"></a><h4>Parameters</h4>
  96 <div class="informaltable"><table width="100%" border="0">
  97 <colgroup>
  98 <col width="150px" class="parameters_name">
  99 <col class="parameters_description">
 100 <col width="200px" class="parameters_annotations">
 101 </colgroup>
 102 <tbody><tr>
 103 <td class="parameter_name"><p>xml_doc</p></td>
 104 <td class="parameter_description"><p>Pointer to <span class="type">xmlDoc</span> to wrap under this object</p></td>
 105 <td class="parameter_annotations"> </td>
 106 </tr></tbody>
 107 </table></div>
 108 </div>
 109 <div class="refsect3">
 110 <a name="id-1.3.6.5.7.2.6"></a><h4>Returns</h4>
 111 <p> 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</p>
 112 <p></p>
 113 </div>
 114 <p class="since">Since 0.13.0</p>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="gupnp-xml-doc-new-from-path"></a><h3>gupnp_xml_doc_new_from_path ()</h3>
 119 <pre class="programlisting"><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="returnvalue">GUPnPXMLDoc</span></a> *
 120 gupnp_xml_doc_new_from_path (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
 121                              <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>
 122 <p>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>
 123 .</p>
 124 <div class="refsect3">
 125 <a name="id-1.3.6.5.7.3.5"></a><h4>Parameters</h4>
 126 <div class="informaltable"><table width="100%" border="0">
 127 <colgroup>
 128 <col width="150px" class="parameters_name">
 129 <col class="parameters_description">
 130 <col width="200px" class="parameters_annotations">
 131 </colgroup>
 132 <tbody>
 133 <tr>
 134 <td class="parameter_name"><p>path</p></td>
 135 <td class="parameter_description"><p>Path to xml document</p></td>
 136 <td class="parameter_annotations"> </td>
 137 </tr>
 138 <tr>
 139 <td class="parameter_name"><p>error</p></td>
 140 <td class="parameter_description"><p>Location to put the error into</p></td>
 141 <td class="parameter_annotations"> </td>
 142 </tr>
 143 </tbody>
 144 </table></div>
 145 </div>
 146 <div class="refsect3">
 147 <a name="id-1.3.6.5.7.3.6"></a><h4>Returns</h4>
 148 <p> 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</p>
 149 <p></p>
 150 </div>
 151 <p class="since">Since 0.13.0</p>
 152 </div>
 153 </div>
 154 <div class="refsect1">
 155 <a name="GUPnPXMLDoc.other_details"></a><h2>Types and Values</h2>
 156 <div class="refsect2">
 157 <a name="GUPnPXMLDoc-struct"></a><h3>struct GUPnPXMLDoc</h3>
 158 <pre class="programlisting">struct GUPnPXMLDoc {
 159         xmlDoc *doc;
 160 };
 161 </pre>
 162 <p>Reference-counting wrapper for libxml's <span class="type">xmlDoc</span></p>
 163 <div class="refsect3">
 164 <a name="id-1.3.6.5.8.2.5"></a><h4>Members</h4>
 165 <div class="informaltable"><table width="100%" border="0">
 166 <colgroup>
 167 <col width="300px" class="struct_members_name">
 168 <col class="struct_members_description">
 169 <col width="200px" class="struct_members_annotations">
 170 </colgroup>
 171 <tbody><tr>
 172 <td class="struct_member_name"><p><span class="type">xmlDoc</span> *<em class="structfield"><code><a name="GUPnPXMLDoc-struct.doc"></a>doc</code></em>;</p></td>
 173 <td class="struct_member_description"><p>Pointer to the document.</p></td>
 174 <td class="struct_member_annotations"> </td>
 175 </tr></tbody>
 176 </table></div>
 177 </div>
 178 </div>
 179 </div>
 180 </div>
 181 <div class="footer">
 182 <hr>
 183           Generated by GTK-Doc V1.20</div>
 184 </body>
 185 </html>