doc/html/GUPnPWhiteList.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: GUPnPWhiteList</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="GUPnPAcl.html" title="GUPnPAcl">
  10 <link rel="next" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory">
  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="#GUPnPWhiteList.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#GUPnPWhiteList.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
  20                   <a href="#GUPnPWhiteList.properties" class="shortcut">Properties</a></span>
  21 </td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  23 <td><a accesskey="u" href="api-utility.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  24 <td><a accesskey="p" href="GUPnPAcl.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  25 <td><a accesskey="n" href="GUPnPResourceFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  26 </tr></table>
  27 <div class="refentry">
  28 <a name="GUPnPWhiteList"></a><div class="titlepage"></div>
  29 <div class="refnamediv"><table width="100%"><tr>
  30 <td valign="top">
  31 <h2><span class="refentrytitle"><a name="GUPnPWhiteList.top_of_page"></a>GUPnPWhiteList</span></h2>
  32 <p>GUPnPWhiteList — Class for network filtering.</p>
  33 </td>
  34 <td class="gallery_image" valign="top" align="right"></td>
  35 </tr></table></div>
  36 <div class="refsect1">
  37 <a name="GUPnPWhiteList.functions"></a><h2>Functions</h2>
  38 <div class="informaltable"><table width="100%" border="0">
  39 <colgroup>
  40 <col width="150px" class="functions_return">
  41 <col class="functions_name">
  42 </colgroup>
  43 <tbody>
  44 <tr>
  45 <td class="function_type">
  46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  47 </td>
  48 <td class="function_name">
  49 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-add-entry" title="gupnp_white_list_add_entry ()">gupnp_white_list_add_entry</a> <span class="c_punctuation">()</span>
  50 </td>
  51 </tr>
  52 <tr>
  53 <td class="function_type">
  54 <span class="returnvalue">void</span>
  55 </td>
  56 <td class="function_name">
  57 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-add-entryv" title="gupnp_white_list_add_entryv ()">gupnp_white_list_add_entryv</a> <span class="c_punctuation">()</span>
  58 </td>
  59 </tr>
  60 <tr>
  61 <td class="function_type">
  62 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  63 </td>
  64 <td class="function_name">
  65 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-check-context" title="gupnp_white_list_check_context ()">gupnp_white_list_check_context</a> <span class="c_punctuation">()</span>
  66 </td>
  67 </tr>
  68 <tr>
  69 <td class="function_type">
  70 <span class="returnvalue">void</span>
  71 </td>
  72 <td class="function_name">
  73 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-clear" title="gupnp_white_list_clear ()">gupnp_white_list_clear</a> <span class="c_punctuation">()</span>
  74 </td>
  75 </tr>
  76 <tr>
  77 <td class="function_type">
  78 <span class="returnvalue">void</span>
  79 </td>
  80 <td class="function_name">
  81 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-set-enabled" title="gupnp_white_list_set_enabled ()">gupnp_white_list_set_enabled</a> <span class="c_punctuation">()</span>
  82 </td>
  83 </tr>
  84 <tr>
  85 <td class="function_type">
  86 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  87 </td>
  88 <td class="function_name">
  89 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-get-entries" title="gupnp_white_list_get_entries ()">gupnp_white_list_get_entries</a> <span class="c_punctuation">()</span>
  90 </td>
  91 </tr>
  92 <tr>
  93 <td class="function_type">
  94 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  95 </td>
  96 <td class="function_name">
  97 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-is-empty" title="gupnp_white_list_is_empty ()">gupnp_white_list_is_empty</a> <span class="c_punctuation">()</span>
  98 </td>
  99 </tr>
 100 <tr>
 101 <td class="function_type">
 102 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 103 </td>
 104 <td class="function_name">
 105 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-get-enabled" title="gupnp_white_list_get_enabled ()">gupnp_white_list_get_enabled</a> <span class="c_punctuation">()</span>
 106 </td>
 107 </tr>
 108 <tr>
 109 <td class="function_type">
 110 <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="returnvalue">GUPnPWhiteList</span></a> *
 111 </td>
 112 <td class="function_name">
 113 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-new" title="gupnp_white_list_new ()">gupnp_white_list_new</a> <span class="c_punctuation">()</span>
 114 </td>
 115 </tr>
 116 <tr>
 117 <td class="function_type">
 118 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 119 </td>
 120 <td class="function_name">
 121 <a class="link" href="GUPnPWhiteList.html#gupnp-white-list-remove-entry" title="gupnp_white_list_remove_entry ()">gupnp_white_list_remove_entry</a> <span class="c_punctuation">()</span>
 122 </td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <div class="refsect1">
 128 <a name="GUPnPWhiteList.properties"></a><h2>Properties</h2>
 129 <div class="informaltable"><table border="0">
 130 <colgroup>
 131 <col width="150px" class="properties_type">
 132 <col width="300px" class="properties_name">
 133 <col width="200px" class="properties_flags">
 134 </colgroup>
 135 <tbody>
 136 <tr>
 137 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 138 <td class="property_name"><a class="link" href="GUPnPWhiteList.html#GUPnPWhiteList--enabled" title="The “enabled” property">enabled</a></td>
 139 <td class="property_flags">Read / Write / Construct</td>
 140 </tr>
 141 <tr>
 142 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
 143 <td class="property_name"><a class="link" href="GUPnPWhiteList.html#GUPnPWhiteList--entries" title="The “entries” property">entries</a></td>
 144 <td class="property_flags">Read / Write / Construct Only</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <div class="refsect1">
 150 <a name="GUPnPWhiteList.other"></a><h2>Types and Values</h2>
 151 <div class="informaltable"><table width="100%" border="0">
 152 <colgroup>
 153 <col width="150px" class="name">
 154 <col class="description">
 155 </colgroup>
 156 <tbody><tr>
 157 <td class="datatype_keyword">struct</td>
 158 <td class="function_name"><a class="link" href="GUPnPWhiteList.html#GUPnPWhiteList-struct" title="struct GUPnPWhiteList">GUPnPWhiteList</a></td>
 159 </tr></tbody>
 160 </table></div>
 161 </div>
 162 <div class="refsect1">
 163 <a name="GUPnPWhiteList.object-hierarchy"></a><h2>Object Hierarchy</h2>
 164 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 165     <span class="lineart">╰──</span> GUPnPWhiteList
 166 </pre>
 167 </div>
 168 <div class="refsect1">
 169 <a name="GUPnPWhiteList.description"></a><h2>Description</h2>
 170 <p><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> handles network filtering. It provides API to manage a list
 171 of entries that will be used to filter networks.
 172 The <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> could be enabled or not. If it's enabled but the entries
 173 list is empty, it behaves as disabled.</p>
 174 </div>
 175 <div class="refsect1">
 176 <a name="GUPnPWhiteList.functions_details"></a><h2>Functions</h2>
 177 <div class="refsect2">
 178 <a name="gupnp-white-list-add-entry"></a><h3>gupnp_white_list_add_entry ()</h3>
 179 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 180 gupnp_white_list_add_entry (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>,
 181                             <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *entry</code></em>);</pre>
 182 <p>Add <em class="parameter"><code>entry</code></em>
 183  in the list of valid criteria used by <em class="parameter"><code>white_list</code></em>
 184  to
 185 filter networks.
 186 if <em class="parameter"><code>entry</code></em>
 187  already exists, it won't be added a second time.</p>
 188 <div class="refsect3">
 189 <a name="id-1.3.6.3.8.2.5"></a><h4>Parameters</h4>
 190 <div class="informaltable"><table width="100%" border="0">
 191 <colgroup>
 192 <col width="150px" class="parameters_name">
 193 <col class="parameters_description">
 194 <col width="200px" class="parameters_annotations">
 195 </colgroup>
 196 <tbody>
 197 <tr>
 198 <td class="parameter_name"><p>white_list</p></td>
 199 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 200 <td class="parameter_annotations"> </td>
 201 </tr>
 202 <tr>
 203 <td class="parameter_name"><p>entry</p></td>
 204 <td class="parameter_description"><p>A value used to filter network</p></td>
 205 <td class="parameter_annotations"> </td>
 206 </tr>
 207 </tbody>
 208 </table></div>
 209 </div>
 210 <div class="refsect3">
 211 <a name="id-1.3.6.3.8.2.6"></a><h4>Returns</h4>
 212 <p> <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>entry</code></em>
 213 is added, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 214 <p></p>
 215 </div>
 216 <p class="since">Since 0.20.5</p>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="gupnp-white-list-add-entryv"></a><h3>gupnp_white_list_add_entryv ()</h3>
 221 <pre class="programlisting"><span class="returnvalue">void</span>
 222 gupnp_white_list_add_entryv (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>,
 223                              <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **entries</code></em>);</pre>
 224 <p>Add a list of entries to a <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a>. This is a helper function to
 225 directly add a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of string usually aquired from
 226 commandline args.</p>
 227 <div class="refsect3">
 228 <a name="id-1.3.6.3.8.3.5"></a><h4>Parameters</h4>
 229 <div class="informaltable"><table width="100%" border="0">
 230 <colgroup>
 231 <col width="150px" class="parameters_name">
 232 <col class="parameters_description">
 233 <col width="200px" class="parameters_annotations">
 234 </colgroup>
 235 <tbody>
 236 <tr>
 237 <td class="parameter_name"><p>white_list</p></td>
 238 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 239 <td class="parameter_annotations"> </td>
 240 </tr>
 241 <tr>
 242 <td class="parameter_name"><p>entries</p></td>
 243 <td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of strings. </p></td>
 244 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
 245 </tr>
 246 </tbody>
 247 </table></div>
 248 </div>
 249 <p class="since">Since 0.20.8</p>
 250 </div>
 251 <hr>
 252 <div class="refsect2">
 253 <a name="gupnp-white-list-check-context"></a><h3>gupnp_white_list_check_context ()</h3>
 254 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 255 gupnp_white_list_check_context (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>,
 256                                 <em class="parameter"><code><a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> *context</code></em>);</pre>
 257 <p>It will check if the <em class="parameter"><code>context</code></em>
 258  is allowed or not. The <em class="parameter"><code>white_list</code></em>
 259  will check
 260 all its entries againt <a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> interface, host ip and network fields
 261 information. This function doesn't take into account the <em class="parameter"><code>white_list</code></em>
 262  status
 263 (enabled or not).</p>
 264 <div class="refsect3">
 265 <a name="id-1.3.6.3.8.4.5"></a><h4>Parameters</h4>
 266 <div class="informaltable"><table width="100%" border="0">
 267 <colgroup>
 268 <col width="150px" class="parameters_name">
 269 <col class="parameters_description">
 270 <col width="200px" class="parameters_annotations">
 271 </colgroup>
 272 <tbody>
 273 <tr>
 274 <td class="parameter_name"><p>white_list</p></td>
 275 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 276 <td class="parameter_annotations"> </td>
 277 </tr>
 278 <tr>
 279 <td class="parameter_name"><p>context</p></td>
 280 <td class="parameter_description"><p>A <a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> to test.</p></td>
 281 <td class="parameter_annotations"> </td>
 282 </tr>
 283 </tbody>
 284 </table></div>
 285 </div>
 286 <div class="refsect3">
 287 <a name="id-1.3.6.3.8.4.6"></a><h4>Returns</h4>
 288 <p> <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>context</code></em>
 289 is matching the <em class="parameter"><code>white_list</code></em>
 290 criterias,
 291 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 292 <p></p>
 293 </div>
 294 <p class="since">Since 0.20.5</p>
 295 </div>
 296 <hr>
 297 <div class="refsect2">
 298 <a name="gupnp-white-list-clear"></a><h3>gupnp_white_list_clear ()</h3>
 299 <pre class="programlisting"><span class="returnvalue">void</span>
 300 gupnp_white_list_clear (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>);</pre>
 301 <p>Remove all entries from <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> that compose the white list.
 302 The list is now empty. Even if <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> is enabled, it will have the
 303 same behavior as if it was disabled.</p>
 304 <div class="refsect3">
 305 <a name="id-1.3.6.3.8.5.5"></a><h4>Parameters</h4>
 306 <div class="informaltable"><table width="100%" border="0">
 307 <colgroup>
 308 <col width="150px" class="parameters_name">
 309 <col class="parameters_description">
 310 <col width="200px" class="parameters_annotations">
 311 </colgroup>
 312 <tbody><tr>
 313 <td class="parameter_name"><p>white_list</p></td>
 314 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 315 <td class="parameter_annotations"> </td>
 316 </tr></tbody>
 317 </table></div>
 318 </div>
 319 <p class="since">Since 0.20.5</p>
 320 </div>
 321 <hr>
 322 <div class="refsect2">
 323 <a name="gupnp-white-list-set-enabled"></a><h3>gupnp_white_list_set_enabled ()</h3>
 324 <pre class="programlisting"><span class="returnvalue">void</span>
 325 gupnp_white_list_set_enabled (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>,
 326                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
 327 <p>Enable or disable the <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> to perform the network filtering.</p>
 328 <div class="refsect3">
 329 <a name="id-1.3.6.3.8.6.5"></a><h4>Parameters</h4>
 330 <div class="informaltable"><table width="100%" border="0">
 331 <colgroup>
 332 <col width="150px" class="parameters_name">
 333 <col class="parameters_description">
 334 <col width="200px" class="parameters_annotations">
 335 </colgroup>
 336 <tbody>
 337 <tr>
 338 <td class="parameter_name"><p>white_list</p></td>
 339 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 340 <td class="parameter_annotations"> </td>
 341 </tr>
 342 <tr>
 343 <td class="parameter_name"><p>enable</p></td>
 344 <td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to enable <em class="parameter"><code>white_list</code></em>
 345 , <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p></td>
 346 <td class="parameter_annotations"> </td>
 347 </tr>
 348 </tbody>
 349 </table></div>
 350 </div>
 351 <p class="since">Since 0.20.5</p>
 352 </div>
 353 <hr>
 354 <div class="refsect2">
 355 <a name="gupnp-white-list-get-entries"></a><h3>gupnp_white_list_get_entries ()</h3>
 356 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 357 gupnp_white_list_get_entries (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>);</pre>
 358 <p>Get the <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of entries that compose the white list. Do not free</p>
 359 <div class="refsect3">
 360 <a name="id-1.3.6.3.8.7.5"></a><h4>Parameters</h4>
 361 <div class="informaltable"><table width="100%" border="0">
 362 <colgroup>
 363 <col width="150px" class="parameters_name">
 364 <col class="parameters_description">
 365 <col width="200px" class="parameters_annotations">
 366 </colgroup>
 367 <tbody><tr>
 368 <td class="parameter_name"><p>white_list</p></td>
 369 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 370 <td class="parameter_annotations"> </td>
 371 </tr></tbody>
 372 </table></div>
 373 </div>
 374 <div class="refsect3">
 375 <a name="id-1.3.6.3.8.7.6"></a><h4>Returns</h4>
 376 <p>  a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of entries
 377 used to filter networks, interfaces,... or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 378 Do not modify or free the list nor its elements. </p>
 379 <p><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></p>
 380 </div>
 381 <p class="since">Since 0.20.5</p>
 382 </div>
 383 <hr>
 384 <div class="refsect2">
 385 <a name="gupnp-white-list-is-empty"></a><h3>gupnp_white_list_is_empty ()</h3>
 386 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 387 gupnp_white_list_is_empty (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>);</pre>
 388 <p>Return the state of the entries list of <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p>
 389 <div class="refsect3">
 390 <a name="id-1.3.6.3.8.8.5"></a><h4>Parameters</h4>
 391 <div class="informaltable"><table width="100%" border="0">
 392 <colgroup>
 393 <col width="150px" class="parameters_name">
 394 <col class="parameters_description">
 395 <col width="200px" class="parameters_annotations">
 396 </colgroup>
 397 <tbody><tr>
 398 <td class="parameter_name"><p>white_list</p></td>
 399 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 400 <td class="parameter_annotations"> </td>
 401 </tr></tbody>
 402 </table></div>
 403 </div>
 404 <div class="refsect3">
 405 <a name="id-1.3.6.3.8.8.6"></a><h4>Returns</h4>
 406 <p> <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>white_list</code></em>
 407 is empty, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 408 <p></p>
 409 </div>
 410 <p class="since">Since 0.20.5</p>
 411 </div>
 412 <hr>
 413 <div class="refsect2">
 414 <a name="gupnp-white-list-get-enabled"></a><h3>gupnp_white_list_get_enabled ()</h3>
 415 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 416 gupnp_white_list_get_enabled (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>);</pre>
 417 <p>Return the status of the <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p>
 418 <div class="refsect3">
 419 <a name="id-1.3.6.3.8.9.5"></a><h4>Parameters</h4>
 420 <div class="informaltable"><table width="100%" border="0">
 421 <colgroup>
 422 <col width="150px" class="parameters_name">
 423 <col class="parameters_description">
 424 <col width="200px" class="parameters_annotations">
 425 </colgroup>
 426 <tbody><tr>
 427 <td class="parameter_name"><p>white_list</p></td>
 428 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 429 <td class="parameter_annotations"> </td>
 430 </tr></tbody>
 431 </table></div>
 432 </div>
 433 <div class="refsect3">
 434 <a name="id-1.3.6.3.8.9.6"></a><h4>Returns</h4>
 435 <p> <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>white_list</code></em>
 436 is enabled, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 437 <p></p>
 438 </div>
 439 <p class="since">Since 0.20.5</p>
 440 </div>
 441 <hr>
 442 <div class="refsect2">
 443 <a name="gupnp-white-list-new"></a><h3>gupnp_white_list_new ()</h3>
 444 <pre class="programlisting"><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="returnvalue">GUPnPWhiteList</span></a> *
 445 gupnp_white_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 446 <p>Create a new <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a>.
 447 The white list is disabled by default.</p>
 448 <div class="refsect3">
 449 <a name="id-1.3.6.3.8.10.5"></a><h4>Returns</h4>
 450 <p> A new <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> object. </p>
 451 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 452 </div>
 453 <p class="since">Since 0.20.5</p>
 454 </div>
 455 <hr>
 456 <div class="refsect2">
 457 <a name="gupnp-white-list-remove-entry"></a><h3>gupnp_white_list_remove_entry ()</h3>
 458 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 459 gupnp_white_list_remove_entry (<em class="parameter"><code><a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a> *white_list</code></em>,
 460                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *entry</code></em>);</pre>
 461 <p>Remove <em class="parameter"><code>entry</code></em>
 462  in the list of valid criteria used by <em class="parameter"><code>white_list</code></em>
 463  to
 464 filter networks.</p>
 465 <div class="refsect3">
 466 <a name="id-1.3.6.3.8.11.5"></a><h4>Parameters</h4>
 467 <div class="informaltable"><table width="100%" border="0">
 468 <colgroup>
 469 <col width="150px" class="parameters_name">
 470 <col class="parameters_description">
 471 <col width="200px" class="parameters_annotations">
 472 </colgroup>
 473 <tbody>
 474 <tr>
 475 <td class="parameter_name"><p>white_list</p></td>
 476 <td class="parameter_description"><p>A <a class="link" href="GUPnPWhiteList.html" title="GUPnPWhiteList"><span class="type">GUPnPWhiteList</span></a></p></td>
 477 <td class="parameter_annotations"> </td>
 478 </tr>
 479 <tr>
 480 <td class="parameter_name"><p>entry</p></td>
 481 <td class="parameter_description"><p>A value to remove from the filter list.</p></td>
 482 <td class="parameter_annotations"> </td>
 483 </tr>
 484 </tbody>
 485 </table></div>
 486 </div>
 487 <div class="refsect3">
 488 <a name="id-1.3.6.3.8.11.6"></a><h4>Returns</h4>
 489 <p> <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>entry</code></em>
 490 is removed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 491 <p></p>
 492 </div>
 493 <p class="since">Since 0.20.5</p>
 494 </div>
 495 </div>
 496 <div class="refsect1">
 497 <a name="GUPnPWhiteList.other_details"></a><h2>Types and Values</h2>
 498 <div class="refsect2">
 499 <a name="GUPnPWhiteList-struct"></a><h3>struct GUPnPWhiteList</h3>
 500 <pre class="programlisting">struct GUPnPWhiteList;</pre>
 501 <p>This struct contains private data only, and should be accessed using the
 502 functions below.</p>
 503 </div>
 504 </div>
 505 <div class="refsect1">
 506 <a name="GUPnPWhiteList.property-details"></a><h2>Property Details</h2>
 507 <div class="refsect2">
 508 <a name="GUPnPWhiteList--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
 509 <pre class="programlisting">  “enabled”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
 510 <p>Whether this white list is active or not.</p>
 511 <p>Flags: Read / Write / Construct</p>
 512 <p>Default value: FALSE</p>
 513 <p class="since">Since 0.20.5</p>
 514 </div>
 515 <hr>
 516 <div class="refsect2">
 517 <a name="GUPnPWhiteList--entries"></a><h3>The <code class="literal">“entries”</code> property</h3>
 518 <pre class="programlisting">  “entries”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
 519 <p>GList of strings that compose the white list.</p>
 520 <p>Flags: Read / Write / Construct Only</p>
 521 </div>
 522 </div>
 523 </div>
 524 <div class="footer">
 525 <hr>
 526           Generated by GTK-Doc V1.20</div>
 527 </body>
 528 </html>