doc/gupnp-dlna/html/gupnp-dlna-gupnp-dlna-restriction.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-dlna-restriction</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GUPnP DLNA Reference Manual">
   8 <link rel="up" href="ch01.html" title="GUPnP DLNA">
   9 <link rel="prev" href="GUPnPDLNAVideoInformation.html" title="GUPnPDLNAVideoInformation">
  10 <link rel="next" href="gupnp-dlna-gupnp-dlna-value-list.html" title="gupnp-dlna-value-list">
  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="GUPnPDLNAVideoInformation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.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 DLNA Reference Manual</th>
  21 <td><a accesskey="n" href="gupnp-dlna-gupnp-dlna-value-list.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-dlna-gupnp-dlna-restriction.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gupnp-dlna-gupnp-dlna-restriction.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gupnp-dlna-gupnp-dlna-restriction.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gupnp-dlna-gupnp-dlna-restriction"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gupnp-dlna-gupnp-dlna-restriction.top_of_page"></a>gupnp-dlna-restriction</span></h2>
  36 <p>gupnp-dlna-restriction</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gupnp-dlna-gupnp-dlna-restriction.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GUPnPDLNARestriction"></a><pre class="synopsis">                    <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction-struct" title="GUPnPDLNARestriction">GUPnPDLNARestriction</a>;
  43 <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="returnvalue">GUPnPDLNARestriction</span></a> * <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-copy" title="gupnp_dlna_restriction_copy ()">gupnp_dlna_restriction_copy</a>      (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  44 <span class="returnvalue">void</span>                <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-free" title="gupnp_dlna_restriction_free ()">gupnp_dlna_restriction_free</a>         (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-get-entries" title="gupnp_dlna_restriction_get_entries ()">gupnp_dlna_restriction_get_entries</a>  (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  46 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-get-mime" title="gupnp_dlna_restriction_get_mime ()">gupnp_dlna_restriction_get_mime</a>     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  47 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-is-empty" title="gupnp_dlna_restriction_is_empty ()">gupnp_dlna_restriction_is_empty</a>     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#gupnp-dlna-restriction-to-string" title="gupnp_dlna_restriction_to_string ()">gupnp_dlna_restriction_to_string</a>    (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gupnp-dlna-gupnp-dlna-restriction.object-hierarchy"></a><h2>Object Hierarchy</h2>
  53 <pre class="synopsis">
  54   GBoxed
  55    +----GUPnPDLNARestriction
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gupnp-dlna-gupnp-dlna-restriction.description"></a><h2>Description</h2>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gupnp-dlna-gupnp-dlna-restriction.details"></a><h2>Details</h2>
  63 <div class="refsect2">
  64 <a name="GUPnPDLNARestriction-struct"></a><h3>GUPnPDLNARestriction</h3>
  65 <pre class="programlisting">typedef struct _GUPnPDLNARestriction GUPnPDLNARestriction;</pre>
  66 </div>
  67 <hr>
  68 <div class="refsect2">
  69 <a name="gupnp-dlna-restriction-copy"></a><h3>gupnp_dlna_restriction_copy ()</h3>
  70 <pre class="programlisting"><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="returnvalue">GUPnPDLNARestriction</span></a> * gupnp_dlna_restriction_copy      (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
  71 <div class="variablelist"><table border="0">
  72 <col align="left" valign="top">
  73 <tbody>
  74 <tr>
  75 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
  76 <td>A restriction to copy. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
  77 </td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  81 <td>A copy of <em class="parameter"><code>restriction</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
  82 </td>
  83 </tr>
  84 </tbody>
  85 </table></div>
  86 </div>
  87 <hr>
  88 <div class="refsect2">
  89 <a name="gupnp-dlna-restriction-free"></a><h3>gupnp_dlna_restriction_free ()</h3>
  90 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_dlna_restriction_free         (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
  91 <p>
  92 Frees <em class="parameter"><code>restriction</code></em>.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody><tr>
  97 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
  98 <td>A restriction to free.</td>
  99 </tr></tbody>
 100 </table></div>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="gupnp-dlna-restriction-get-entries"></a><h3>gupnp_dlna_restriction_get_entries ()</h3>
 105 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        gupnp_dlna_restriction_get_entries  (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
 106 <p>
 107 Gets <em class="parameter"><code>restriction</code></em>'s entries. It is a string to <a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a>
 108 mapping.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
 115 <td>A restriction. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 116 </td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 120 <td>Entries. Do not modify. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GUPnPDLNAValueList]</span>
 121 </td>
 122 </tr>
 123 </tbody>
 124 </table></div>
 125 </div>
 126 <hr>
 127 <div class="refsect2">
 128 <a name="gupnp-dlna-restriction-get-mime"></a><h3>gupnp_dlna_restriction_get_mime ()</h3>
 129 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gupnp_dlna_restriction_get_mime     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
 130 <p>
 131 Gets <em class="parameter"><code>restriction</code></em>'s MIME type.
 132 </p>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
 138 <td>A restriction. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 139 </td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 143 <td>MIME type. Do not modify. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 144 </td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="gupnp-dlna-restriction-is-empty"></a><h3>gupnp_dlna_restriction_is_empty ()</h3>
 152 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gupnp_dlna_restriction_is_empty     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
 158 <td>A restriction. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 159 </td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 163 <td>
 164 <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>restriction</code></em> is empty and has no MIME type,
 165 otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 <hr>
 171 <div class="refsect2">
 172 <a name="gupnp-dlna-restriction-to-string"></a><h3>gupnp_dlna_restriction_to_string ()</h3>
 173 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gupnp_dlna_restriction_to_string    (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-restriction.html#GUPnPDLNARestriction"><span class="type">GUPnPDLNARestriction</span></a> *restriction</code></em>);</pre>
 174 <p>
 175 Creates a string representation of <em class="parameter"><code>restriction</code></em>.
 176 </p>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term"><em class="parameter"><code>restriction</code></em> :</span></p></td>
 182 <td>A restriction. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 183 </td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 187 <td>A string representation of
 188 <em class="parameter"><code>restriction</code></em>. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 189 </td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 </div>
 195 </div>
 196 <div class="footer">
 197 <hr>
 198           Generated by GTK-Doc V1.18</div>
 199 </body>
 200 </html>