doc/html/gupnp-gupnp-service-introspection.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>GUPnPServiceIntrospection</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-device-info.html" title="Device Information">
   9 <link rel="prev" href="GUPnPServiceInfo.html" title="GUPnPServiceInfo">
  10 <link rel="next" href="api-device-control.html" title="Device Control">
  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="GUPnPServiceInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="api-device-info.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="api-device-control.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="#gupnp-gupnp-service-introspection.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gupnp-gupnp-service-introspection.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gupnp-gupnp-service-introspection.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gupnp-gupnp-service-introspection.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gupnp-gupnp-service-introspection"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gupnp-gupnp-service-introspection.top_of_page"></a>GUPnPServiceIntrospection</span></h2>
  38 <p>GUPnPServiceIntrospection — Service introspection class.</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gupnp-gupnp-service-introspection.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GUPnPServiceIntrospection"></a><pre class="synopsis">enum                <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionArgDirection" title="enum GUPnPServiceActionArgDirection">GUPnPServiceActionArgDirection</a>;
  45                     <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionArgInfo" title="GUPnPServiceActionArgInfo">GUPnPServiceActionArgInfo</a>;
  46                     <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionInfo" title="GUPnPServiceActionInfo">GUPnPServiceActionInfo</a>;
  47                     <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceStateVariableInfo" title="GUPnPServiceStateVariableInfo">GUPnPServiceStateVariableInfo</a>;
  48 struct              <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection-struct" title="struct GUPnPServiceIntrospection">GUPnPServiceIntrospection</a>;
  49 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-list-action-names" title="gupnp_service_introspection_list_action_names ()">gupnp_service_introspection_list_action_names</a>
  50                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);
  51 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-list-actions" title="gupnp_service_introspection_list_actions ()">gupnp_service_introspection_list_actions</a>
  52                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);
  53 const <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionInfo" title="GUPnPServiceActionInfo"><span class="returnvalue">GUPnPServiceActionInfo</span></a> * <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-get-action" title="gupnp_service_introspection_get_action ()">gupnp_service_introspection_get_action</a>
  54                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>,
  55                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);
  56 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-list-state-variable-names" title="gupnp_service_introspection_list_state_variable_names ()">gupnp_service_introspection_list_state_variable_names</a>
  57                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);
  58 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-list-state-variables" title="gupnp_service_introspection_list_state_variables ()">gupnp_service_introspection_list_state_variables</a>
  59                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);
  60 const <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceStateVariableInfo" title="GUPnPServiceStateVariableInfo"><span class="returnvalue">GUPnPServiceStateVariableInfo</span></a> * <a class="link" href="gupnp-gupnp-service-introspection.html#gupnp-service-introspection-get-state-variable" title="gupnp_service_introspection_get_state_variable ()">gupnp_service_introspection_get_state_variable</a>
  61                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>,
  62                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *variable_name</code></em>);
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gupnp-gupnp-service-introspection.object-hierarchy"></a><h2>Object Hierarchy</h2>
  67 <pre class="synopsis">
  68   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  69    +----GUPnPServiceIntrospection
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="gupnp-gupnp-service-introspection.properties"></a><h2>Properties</h2>
  74 <pre class="synopsis">
  75   "<a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection--scpd" title='The "scpd" property'>scpd</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="gupnp-gupnp-service-introspection.description"></a><h2>Description</h2>
  80 <p>
  81 The <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> class provides methods for service
  82 introspection based on information contained in its service description
  83 document (SCPD). There is no constructor provided for this class, please use
  84 <a class="link" href="GUPnPServiceInfo.html#gupnp-service-info-get-introspection" title="gupnp_service_info_get_introspection ()"><span class="type">gupnp_service_info_get_introspection</span></a> or
  85 <a class="link" href="GUPnPServiceInfo.html#gupnp-service-info-get-introspection-async" title="gupnp_service_info_get_introspection_async ()"><span class="type">gupnp_service_info_get_introspection_async</span></a> to create an
  86 <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> object for a specific service.
  87 </p>
  88 <p>
  89 Note that all the introspection information is retreived from the service
  90 description document (SCPD) provided by the service and hence can not be
  91 guaranteed to be complete. A UPnP service is required to provide an SCPD but
  92 unfortunately, many services either do not provide this document or the
  93 document does not provide any or all of the introspection information.
  94 </p>
  95 <p>
  96 This class exposes internals of the UPnP protocol and should not need
  97 to be used for regular device or control point development.
  98 </p>
  99 </div>
 100 <div class="refsect1">
 101 <a name="gupnp-gupnp-service-introspection.details"></a><h2>Details</h2>
 102 <div class="refsect2">
 103 <a name="GUPnPServiceActionArgDirection"></a><h3>enum GUPnPServiceActionArgDirection</h3>
 104 <pre class="programlisting">typedef enum {
 105         GUPNP_SERVICE_ACTION_ARG_DIRECTION_IN,
 106         GUPNP_SERVICE_ACTION_ARG_DIRECTION_OUT
 107 } GUPnPServiceActionArgDirection;
 108 </pre>
 109 <p>
 110 Represents the direction of a service state variable.
 111 </p>
 112 <div class="variablelist"><table border="0">
 113 <col align="left" valign="top">
 114 <tbody>
 115 <tr>
 116 <td><p><a name="GUPNP-SERVICE-ACTION-ARG-DIRECTION-IN:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVICE_ACTION_ARG_DIRECTION_IN</code></span></p></td>
 117 <td>An "in" variable, to the service.
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><a name="GUPNP-SERVICE-ACTION-ARG-DIRECTION-OUT:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVICE_ACTION_ARG_DIRECTION_OUT</code></span></p></td>
 122 <td>An "out" variable, from the service.
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="GUPnPServiceActionArgInfo"></a><h3>GUPnPServiceActionArgInfo</h3>
 131 <pre class="programlisting">typedef struct {
 132         char                          *name;
 133         GUPnPServiceActionArgDirection direction;
 134         char                          *related_state_variable;
 135         gboolean                       retval;
 136 } GUPnPServiceActionArgInfo;
 137 </pre>
 138 <p>
 139 This structure contains information about the argument of service action.
 140 </p>
 141 <div class="variablelist"><table border="0">
 142 <col align="left" valign="top">
 143 <tbody>
 144 <tr>
 145 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GUPnPServiceActionArgInfo.name"></a>name</code></em>;</span></p></td>
 146 <td>The name of the action argument.</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionArgDirection" title="enum GUPnPServiceActionArgDirection"><span class="type">GUPnPServiceActionArgDirection</span></a> <em class="structfield"><code><a name="GUPnPServiceActionArgInfo.direction"></a>direction</code></em>;</span></p></td>
 150 <td>The direction of the action argument.</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GUPnPServiceActionArgInfo.related-state-variable"></a>related_state_variable</code></em>;</span></p></td>
 154 <td>The name of the state variable associated with this
 155 argument.</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GUPnPServiceActionArgInfo.retval"></a>retval</code></em>;</span></p></td>
 159 <td>Whether this argument is the return value of the action.</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="GUPnPServiceActionInfo"></a><h3>GUPnPServiceActionInfo</h3>
 167 <pre class="programlisting">typedef struct {
 168         char  *name;
 169         GList *arguments; /* list of #GUPnPServiceActionArgInfo */
 170 } GUPnPServiceActionInfo;
 171 </pre>
 172 <p>
 173 This structure contains information about a service action.
 174 </p>
 175 <div class="variablelist"><table border="0">
 176 <col align="left" valign="top">
 177 <tbody>
 178 <tr>
 179 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GUPnPServiceActionInfo.name"></a>name</code></em>;</span></p></td>
 180 <td>The name of the action argument.</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GUPnPServiceActionInfo.arguments"></a>arguments</code></em>;</span></p></td>
 184 <td>A GList of all the arguments
 185 (of type <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionArgInfo" title="GUPnPServiceActionArgInfo"><span class="type">GUPnPServiceActionArgInfo</span></a>) of this action.</td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="GUPnPServiceStateVariableInfo"></a><h3>GUPnPServiceStateVariableInfo</h3>
 193 <pre class="programlisting">typedef struct {
 194         char    *name;
 195         gboolean send_events;
 196         gboolean is_numeric;
 197         GType    type;
 198         GValue   default_value;
 199         GValue   minimum;
 200         GValue   maximum;
 201         GValue   step;
 202         GList   *allowed_values;
 203 } GUPnPServiceStateVariableInfo;
 204 </pre>
 205 <p>
 206 This structure contains information about service state variable.
 207 </p>
 208 <div class="variablelist"><table border="0">
 209 <col align="left" valign="top">
 210 <tbody>
 211 <tr>
 212 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.name"></a>name</code></em>;</span></p></td>
 213 <td>The name of the state variable.</td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.send-events"></a>send_events</code></em>;</span></p></td>
 217 <td>Whether this state variable can source events.</td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.is-numeric"></a>is_numeric</code></em>;</span></p></td>
 221 <td>Wether this state variable is a numeric type (integer and
 222 float).</td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.type"></a>type</code></em>;</span></p></td>
 226 <td>The GType of this state variable.</td>
 227 </tr>
 228 <tr>
 229 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.default-value"></a>default_value</code></em>;</span></p></td>
 230 <td>The default value of this state variable.</td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.minimum"></a>minimum</code></em>;</span></p></td>
 234 <td>The minimum value of this state variable. Only applies to numeric
 235 data types.</td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.maximum"></a>maximum</code></em>;</span></p></td>
 239 <td>The maximum value of this state variable. Only applies to numeric
 240 data types.</td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.step"></a>step</code></em>;</span></p></td>
 244 <td>The step value of this state variable. Only applies to numeric
 245 data types.</td>
 246 </tr>
 247 <tr>
 248 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GUPnPServiceStateVariableInfo.allowed-values"></a>allowed_values</code></em>;</span></p></td>
 249 <td>The allowed values of this state variable. Only applies to
 250 string data types. Unlike the other fields in this structure, this field
 251 contains a list of (char *) strings rather than GValues.</td>
 252 </tr>
 253 </tbody>
 254 </table></div>
 255 </div>
 256 <hr>
 257 <div class="refsect2">
 258 <a name="GUPnPServiceIntrospection-struct"></a><h3>struct GUPnPServiceIntrospection</h3>
 259 <pre class="programlisting">struct GUPnPServiceIntrospection;</pre>
 260 <p>
 261 This struct contains private data only, and should be accessed using the
 262 functions below.
 263 </p>
 264 </div>
 265 <hr>
 266 <div class="refsect2">
 267 <a name="gupnp-service-introspection-list-action-names"></a><h3>gupnp_service_introspection_list_action_names ()</h3>
 268 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gupnp_service_introspection_list_action_names
 269                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);</pre>
 270 <p>
 271 Returns a GList of names of all the actions in this service.
 272 </p>
 273 <div class="variablelist"><table border="0">
 274 <col align="left" valign="top">
 275 <tbody>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 278 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 279 </td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 283 <td>(transfer none) (element-type utf8) : A GList of names of all
 284 the actions or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free it or its contents.</td>
 285 </tr>
 286 </tbody>
 287 </table></div>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="gupnp-service-introspection-list-actions"></a><h3>gupnp_service_introspection_list_actions ()</h3>
 292 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gupnp_service_introspection_list_actions
 293                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);</pre>
 294 <p>
 295 Returns a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of all the actions (of type <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionInfo" title="GUPnPServiceActionInfo"><span class="type">GUPnPServiceActionInfo</span></a>) in
 296 this service.
 297 </p>
 298 <div class="variablelist"><table border="0">
 299 <col align="left" valign="top">
 300 <tbody>
 301 <tr>
 302 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 303 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 304 </td>
 305 </tr>
 306 <tr>
 307 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 308 <td>A
 309 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of all the actions or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free it or its
 310 contents. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GUPnP.ServiceActionInfo*][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 311 </td>
 312 </tr>
 313 </tbody>
 314 </table></div>
 315 </div>
 316 <hr>
 317 <div class="refsect2">
 318 <a name="gupnp-service-introspection-get-action"></a><h3>gupnp_service_introspection_get_action ()</h3>
 319 <pre class="programlisting">const <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceActionInfo" title="GUPnPServiceActionInfo"><span class="returnvalue">GUPnPServiceActionInfo</span></a> * gupnp_service_introspection_get_action
 320                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>,
 321                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
 322 <p>
 323 Returns the action by the name <em class="parameter"><code>action_name</code></em> in this service.
 324 </p>
 325 <div class="variablelist"><table border="0">
 326 <col align="left" valign="top">
 327 <tbody>
 328 <tr>
 329 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 330 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 331 </td>
 332 </tr>
 333 <tr>
 334 <td><p><span class="term"><em class="parameter"><code>action_name</code></em> :</span></p></td>
 335 <td>The name of the action to retreive</td>
 336 </tr>
 337 <tr>
 338 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 339 <td>the action or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free
 340 it. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 341 </td>
 342 </tr>
 343 </tbody>
 344 </table></div>
 345 </div>
 346 <hr>
 347 <div class="refsect2">
 348 <a name="gupnp-service-introspection-list-state-variable-names"></a><h3>gupnp_service_introspection_list_state_variable_names ()</h3>
 349 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gupnp_service_introspection_list_state_variable_names
 350                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);</pre>
 351 <p>
 352 Returns a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of names of all the state variables in this service.
 353 </p>
 354 <div class="variablelist"><table border="0">
 355 <col align="left" valign="top">
 356 <tbody>
 357 <tr>
 358 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 359 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 360 </td>
 361 </tr>
 362 <tr>
 363 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 364 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of names of all
 365 the state variables or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free it or its contents. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 366 </td>
 367 </tr>
 368 </tbody>
 369 </table></div>
 370 </div>
 371 <hr>
 372 <div class="refsect2">
 373 <a name="gupnp-service-introspection-list-state-variables"></a><h3>gupnp_service_introspection_list_state_variables ()</h3>
 374 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gupnp_service_introspection_list_state_variables
 375                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>);</pre>
 376 <p>
 377 Returns a GList of all the state variables (of type
 378 <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceStateVariableInfo" title="GUPnPServiceStateVariableInfo"><span class="type">GUPnPServiceStateVariableInfo</span></a>) in this service.
 379 </p>
 380 <div class="variablelist"><table border="0">
 381 <col align="left" valign="top">
 382 <tbody>
 383 <tr>
 384 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 385 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 386 </td>
 387 </tr>
 388 <tr>
 389 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 390 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of all the state variables or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free it or
 391 its contents. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GUPnP.ServiceStateVariableInfo][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 392 </td>
 393 </tr>
 394 </tbody>
 395 </table></div>
 396 </div>
 397 <hr>
 398 <div class="refsect2">
 399 <a name="gupnp-service-introspection-get-state-variable"></a><h3>gupnp_service_introspection_get_state_variable ()</h3>
 400 <pre class="programlisting">const <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceStateVariableInfo" title="GUPnPServiceStateVariableInfo"><span class="returnvalue">GUPnPServiceStateVariableInfo</span></a> * gupnp_service_introspection_get_state_variable
 401                                                         (<em class="parameter"><code><a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a> *introspection</code></em>,
 402                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *variable_name</code></em>);</pre>
 403 <p>
 404 Returns the state variable by the name <em class="parameter"><code>variable_name</code></em> in this service.
 405 </p>
 406 <div class="variablelist"><table border="0">
 407 <col align="left" valign="top">
 408 <tbody>
 409 <tr>
 410 <td><p><span class="term"><em class="parameter"><code>introspection</code></em> :</span></p></td>
 411 <td>A <a class="link" href="gupnp-gupnp-service-introspection.html#GUPnPServiceIntrospection"><span class="type">GUPnPServiceIntrospection</span></a>
 412 </td>
 413 </tr>
 414 <tr>
 415 <td><p><span class="term"><em class="parameter"><code>variable_name</code></em> :</span></p></td>
 416 <td>The name of the variable to retreive</td>
 417 </tr>
 418 <tr>
 419 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 420 <td>the state variable or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not modify or free it.</td>
 421 </tr>
 422 </tbody>
 423 </table></div>
 424 </div>
 425 </div>
 426 <div class="refsect1">
 427 <a name="gupnp-gupnp-service-introspection.property-details"></a><h2>Property Details</h2>
 428 <div class="refsect2">
 429 <a name="GUPnPServiceIntrospection--scpd"></a><h3>The <code class="literal">"scpd"</code> property</h3>
 430 <pre class="programlisting">  "scpd"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only</pre>
 431 <p>
 432 The scpd of the device description file.
 433 </p>
 434 </div>
 435 </div>
 436 </div>
 437 <div class="footer">
 438 <hr>
 439           Generated by GTK-Doc V1.18</div>
 440 </body>
 441 </html>