Submit version 0.20.1 of GUPnP (4186015)

[profile/ivi/GUPnP.git] / doc / html / GUPnPRootDevice.html

diff --git a/doc/html/GUPnPRootDevice.html b/doc/html/GUPnPRootDevice.html
index 9d5c3eb..2dc72fe 100644 (file)
--- a/doc/html/GUPnPRootDevice.html
+++ b/doc/html/GUPnPRootDevice.html
@@ -51,20 +51,22 @@
                                                          <em class="parameter"><code>const <span class="type">char</span> *description_path</code></em>,
                                                          <em class="parameter"><code>const <span class="type">char</span> *description_dir</code></em>);
 <span class="returnvalue">void</span>                <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-set-available" title="gupnp_root_device_set_available ()">gupnp_root_device_set_available</a>     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>,
-                                                         <em class="parameter"><code><span class="type">gboolean</span> available</code></em>);
-<span class="returnvalue">gboolean</span>            <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-available" title="gupnp_root_device_get_available ()">gupnp_root_device_get_available</a>     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> available</code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-available" title="gupnp_root_device_get_available ()">gupnp_root_device_get_available</a>     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
 const <span class="returnvalue">char</span> *        <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-relative-location" title="gupnp_root_device_get_relative_location ()">gupnp_root_device_get_relative_location</a>
                                                         (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
 const <span class="returnvalue">char</span> *        <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-description-dir" title="gupnp_root_device_get_description_dir ()">gupnp_root_device_get_description_dir</a>
                                                         (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
 const <span class="returnvalue">char</span> *        <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-description-path" title="gupnp_root_device_get_description_path ()">gupnp_root_device_get_description_path</a>
                                                         (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
+<span class="returnvalue">GSSDPResourceGroup</span> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-ssdp-resource-group" title="gupnp_root_device_get_ssdp_resource_group ()">gupnp_root_device_get_ssdp_resource_group</a>
+                                                        (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
 </pre>
 </div>
 <div class="refsect1">
 <a name="GUPnPRootDevice.object-hierarchy"></a><h2>Object Hierarchy</h2>
 <pre class="synopsis">
-  GObject
+  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    +----<a class="link" href="GUPnPDeviceInfo.html" title="GUPnPDeviceInfo">GUPnPDeviceInfo</a>
          +----<a class="link" href="GUPnPDevice.html" title="GUPnPDevice">GUPnPDevice</a>
                +----GUPnPRootDevice
@@ -73,10 +75,10 @@ const <span class="returnvalue">char</span> *        <a class="link" href="GUPnP
 <div class="refsect1">
 <a name="GUPnPRootDevice.properties"></a><h2>Properties</h2>
 <pre class="synopsis">
-  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--available" title='The "available" property'>available</a>"                <span class="type">gboolean</span>              : Read / Write
-  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-dir" title='The "description-dir" property'>description-dir</a>"          <span class="type">gchar</span>*                : Read / Write / Construct Only
+  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--available" title='The "available" property'>available</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
+  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-dir" title='The "description-dir" property'>description-dir</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
   "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-doc" title='The "description-doc" property'>description-doc</a>"          <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a>*          : Write / Construct Only
-  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-path" title='The "description-path" property'>description-path</a>"         <span class="type">gchar</span>*                : Read / Write / Construct Only
+  "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-path" title='The "description-path" property'>description-path</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 </pre>
 </div>
 <div class="refsect1">
@@ -140,7 +142,7 @@ be an absolute path or path relative to <em class="parameter"><code>description_
 <p>
 Create a new <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>, automatically loading and parsing
 device description document from <em class="parameter"><code>description_path</code></em> if <em class="parameter"><code>description_doc</code></em> is
-<code class="literal">NULL</code>.
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 </p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
@@ -157,7 +159,7 @@ device description document from <em class="parameter"><code>description_path</c
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>description_doc</code></em> :</span></p></td>
-<td>Device description document, or <code class="literal">NULL</code>
+<td>Device description document, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 </td>
 </tr>
 <tr>
@@ -180,7 +182,7 @@ be an absolute path or path relative to <em class="parameter"><code>description_
 <div class="refsect2">
 <a name="gupnp-root-device-set-available"></a><h3>gupnp_root_device_set_available ()</h3>
 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_root_device_set_available     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>,
-                                                         <em class="parameter"><code><span class="type">gboolean</span> available</code></em>);</pre>
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> available</code></em>);</pre>
 <p>
 Controls whether or not <em class="parameter"><code>root_device</code></em> is available (announcing
 its presence).
@@ -196,7 +198,7 @@ its presence).
 <tr>
 <td><p><span class="term"><em class="parameter"><code>available</code></em> :</span></p></td>
 <td>
-<code class="literal">TRUE</code> if <em class="parameter"><code>root_device</code></em> should be available</td>
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>root_device</code></em> should be available</td>
 </tr>
 </tbody>
 </table></div>
@@ -204,7 +206,7 @@ its presence).
 <hr>
 <div class="refsect2">
 <a name="gupnp-root-device-get-available"></a><h3>gupnp_root_device_get_available ()</h3>
-<pre class="programlisting"><span class="returnvalue">gboolean</span>            gupnp_root_device_get_available     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gupnp_root_device_get_available     (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
 <p>
 Get whether or not <em class="parameter"><code>root_device</code></em> is available (announcing its presence).
 </p>
@@ -219,7 +221,7 @@ Get whether or not <em class="parameter"><code>root_device</code></em> is availa
 <tr>
 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 <td>
-<code class="literal">TRUE</code> if <em class="parameter"><code>root_device</code></em> is available, <code class="literal">FALSE</code> otherwise.</td>
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>root_device</code></em> is available, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 </tr>
 </tbody>
 </table></div>
@@ -294,12 +296,36 @@ Get the path to the device description document of <em class="parameter"><code>r
 </tbody>
 </table></div>
 </div>
+<hr>
+<div class="refsect2">
+<a name="gupnp-root-device-get-ssdp-resource-group"></a><h3>gupnp_root_device_get_ssdp_resource_group ()</h3>
+<pre class="programlisting"><span class="returnvalue">GSSDPResourceGroup</span> * gupnp_root_device_get_ssdp_resource_group
+                                                        (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
+<p>
+Get the <span class="type">GSSDPResourceGroup</span> used by <em class="parameter"><code>root_device</code></em>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
+<td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>The <span class="type">GSSDPResourceGroup</span> of <em class="parameter"><code>root_device</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
 </div>
 <div class="refsect1">
 <a name="GUPnPRootDevice.property-details"></a><h2>Property Details</h2>
 <div class="refsect2">
 <a name="GUPnPRootDevice--available"></a><h3>The <code class="literal">"available"</code> property</h3>
-<pre class="programlisting">  "available"                <span class="type">gboolean</span>              : Read / Write</pre>
+<pre class="programlisting">  "available"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 <p>
 TRUE if this device is available.
 </p>
@@ -308,7 +334,7 @@ TRUE if this device is available.
 <hr>
 <div class="refsect2">
 <a name="GUPnPRootDevice--description-dir"></a><h3>The <code class="literal">"description-dir"</code> property</h3>
-<pre class="programlisting">  "description-dir"          <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
+<pre class="programlisting">  "description-dir"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 <p>
 The path to directory where description documents are provided.
 </p>
@@ -325,7 +351,7 @@ Device description document. Constructor property.
 <hr>
 <div class="refsect2">
 <a name="GUPnPRootDevice--description-path"></a><h3>The <code class="literal">"description-path"</code> property</h3>
-<pre class="programlisting">  "description-path"         <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
+<pre class="programlisting">  "description-path"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 <p>
 The path to device description document. This could either be an
 absolute path or path relative to GUPnPRootDevice:description-dir.