Update gupnp-dlna to 0.10.2 (34fee04)
[profile/ivi/GUPnP-DLNA.git] / doc / gupnp-dlna / html / gupnp-dlna-gupnp-dlna-value-list.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-value-list</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="gupnp-dlna-gupnp-dlna-restriction.html" title="gupnp-dlna-restriction">
10 <link rel="next" href="gupnp-dlna-gupnp-dlna-g-values.html" title="gupnp-dlna-g-values">
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="gupnp-dlna-gupnp-dlna-restriction.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-g-values.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-value-list.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gupnp-dlna-gupnp-dlna-value-list.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gupnp-dlna-gupnp-dlna-value-list.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="gupnp-dlna-gupnp-dlna-value-list"></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-value-list.top_of_page"></a>gupnp-dlna-value-list</span></h2>
36 <p>gupnp-dlna-value-list</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-value-list.synopsis"></a><h2>Synopsis</h2>
42 <a name="GUPnPDLNAValueList"></a><pre class="synopsis">                    <a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList-struct" title="GUPnPDLNAValueList">GUPnPDLNAValueList</a>;
43 <a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="returnvalue">GUPnPDLNAValueList</span></a> * <a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#gupnp-dlna-value-list-copy" title="gupnp_dlna_value_list_copy ()">gupnp_dlna_value_list_copy</a>         (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);
44 <span class="returnvalue">void</span>                <a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#gupnp-dlna-value-list-free" title="gupnp_dlna_value_list_free ()">gupnp_dlna_value_list_free</a>          (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);
45 <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-dlna-gupnp-dlna-value-list.html#gupnp-dlna-value-list-get-g-values" title="gupnp_dlna_value_list_get_g_values ()">gupnp_dlna_value_list_get_g_values</a>  (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);
46 <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-value-list.html#gupnp-dlna-value-list-is-empty" title="gupnp_dlna_value_list_is_empty ()">gupnp_dlna_value_list_is_empty</a>      (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);
47 <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-value-list.html#gupnp-dlna-value-list-to-string" title="gupnp_dlna_value_list_to_string ()">gupnp_dlna_value_list_to_string</a>     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);
48 </pre>
49 </div>
50 <div class="refsect1">
51 <a name="gupnp-dlna-gupnp-dlna-value-list.object-hierarchy"></a><h2>Object Hierarchy</h2>
52 <pre class="synopsis">
53   GBoxed
54    +----GUPnPDLNAValueList
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gupnp-dlna-gupnp-dlna-value-list.description"></a><h2>Description</h2>
59 </div>
60 <div class="refsect1">
61 <a name="gupnp-dlna-gupnp-dlna-value-list.details"></a><h2>Details</h2>
62 <div class="refsect2">
63 <a name="GUPnPDLNAValueList-struct"></a><h3>GUPnPDLNAValueList</h3>
64 <pre class="programlisting">typedef struct _GUPnPDLNAValueList GUPnPDLNAValueList;</pre>
65 </div>
66 <hr>
67 <div class="refsect2">
68 <a name="gupnp-dlna-value-list-copy"></a><h3>gupnp_dlna_value_list_copy ()</h3>
69 <pre class="programlisting"><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="returnvalue">GUPnPDLNAValueList</span></a> * gupnp_dlna_value_list_copy         (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);</pre>
70 <div class="variablelist"><table border="0">
71 <col align="left" valign="top">
72 <tbody>
73 <tr>
74 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
75 <td>A list to copy. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
76 </td>
77 </tr>
78 <tr>
79 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
80 <td>A copy of <em class="parameter"><code>list</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
81 </td>
82 </tr>
83 </tbody>
84 </table></div>
85 </div>
86 <hr>
87 <div class="refsect2">
88 <a name="gupnp-dlna-value-list-free"></a><h3>gupnp_dlna_value_list_free ()</h3>
89 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_dlna_value_list_free          (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);</pre>
90 <p>
91 Frees the value list.
92 </p>
93 <div class="variablelist"><table border="0">
94 <col align="left" valign="top">
95 <tbody><tr>
96 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
97 <td>A list to free.</td>
98 </tr></tbody>
99 </table></div>
100 </div>
101 <hr>
102 <div class="refsect2">
103 <a name="gupnp-dlna-value-list-get-g-values"></a><h3>gupnp_dlna_value_list_get_g_values ()</h3>
104 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gupnp_dlna_value_list_get_g_values  (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);</pre>
105 <p>
106 Gets a list of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValues</span></a>. <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValues</span></a> can be of types <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS"><span class="type">G_TYPE_BOOLEAN</span></a>,
107 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INT:CAPS"><span class="type">G_TYPE_INT</span></a>, <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><span class="type">G_TYPE_STRING</span></a>, <span class="type">GUPNP_TYPE_DLNA_FRACTION</span>,
108 <span class="type">GUPNP_TYPE_DLNA_FRACTION_RANGE</span> or <span class="type">GUPNP_TYPE_DLNA_INT_RANGE</span>.
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>list</code></em> :</span></p></td>
115 <td>A list. <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>A list. Free it
121 with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free-full"><code class="function">g_list_free_full()</code></a> with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GValue]</span>
122 </td>
123 </tr>
124 </tbody>
125 </table></div>
126 </div>
127 <hr>
128 <div class="refsect2">
129 <a name="gupnp-dlna-value-list-is-empty"></a><h3>gupnp_dlna_value_list_is_empty ()</h3>
130 <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_value_list_is_empty      (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);</pre>
131 <div class="variablelist"><table border="0">
132 <col align="left" valign="top">
133 <tbody>
134 <tr>
135 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
136 <td>A list. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
137 </td>
138 </tr>
139 <tr>
140 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
141 <td>
142 <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>list</code></em> is empty, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
143 </tr>
144 </tbody>
145 </table></div>
146 </div>
147 <hr>
148 <div class="refsect2">
149 <a name="gupnp-dlna-value-list-to-string"></a><h3>gupnp_dlna_value_list_to_string ()</h3>
150 <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_value_list_to_string     (<em class="parameter"><code><a class="link" href="gupnp-dlna-gupnp-dlna-value-list.html#GUPnPDLNAValueList"><span class="type">GUPnPDLNAValueList</span></a> *list</code></em>);</pre>
151 <p>
152 Creates a string representation of <em class="parameter"><code>list</code></em>.
153 </p>
154 <div class="variablelist"><table border="0">
155 <col align="left" valign="top">
156 <tbody>
157 <tr>
158 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
159 <td>A list. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
160 </td>
161 </tr>
162 <tr>
163 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
164 <td>A string representation of <em class="parameter"><code>list</code></em>. Free
165 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>
166 </td>
167 </tr>
168 </tbody>
169 </table></div>
170 </div>
171 </div>
172 </div>
173 <div class="footer">
174 <hr>
175           Generated by GTK-Doc V1.18</div>
176 </body>
177 </html>