libudev/docs/html/libudev-udev-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>udev_list</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="libudev Reference Manual">
   8 <link rel="up" href="ch01.html" title="libudev">
   9 <link rel="prev" href="libudev-udev.html" title="udev">
  10 <link rel="next" href="libudev-udev-device.html" title="udev_device">
  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="libudev-udev.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">libudev Reference Manual</th>
  21 <td><a accesskey="n" href="libudev-udev-device.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="#libudev-udev-list.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libudev-udev-list.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libudev-udev-list"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libudev-udev-list.top_of_page"></a>udev_list</span></h2>
  34 <p>udev_list — list operation</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libudev-udev-list.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry">udev_list_entry</a>;
  41 struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * <a class="link" href="libudev-udev-list.html#udev-list-entry-get-next" title="udev_list_entry_get_next ()">udev_list_entry_get_next</a>       (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>);
  42 struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * <a class="link" href="libudev-udev-list.html#udev-list-entry-get-by-name" title="udev_list_entry_get_by_name ()">udev_list_entry_get_by_name</a>    (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>,
  43                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
  44 const <span class="returnvalue">char</span> *        <a class="link" href="libudev-udev-list.html#udev-list-entry-get-name" title="udev_list_entry_get_name ()">udev_list_entry_get_name</a>            (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>);
  45 const <span class="returnvalue">char</span> *        <a class="link" href="libudev-udev-list.html#udev-list-entry-get-value" title="udev_list_entry_get_value ()">udev_list_entry_get_value</a>           (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>);
  46 #define             <a class="link" href="libudev-udev-list.html#udev-list-entry-foreach" title="udev_list_entry_foreach()">udev_list_entry_foreach</a>             (list_entry,
  47                                                          first_entry)
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="libudev-udev-list.description"></a><h2>Description</h2>
  52 <p>
  53 Libudev list operations.
  54 </p>
  55 </div>
  56 <div class="refsect1">
  57 <a name="libudev-udev-list.details"></a><h2>Details</h2>
  58 <div class="refsect2">
  59 <a name="udev-list-entry"></a><h3>struct udev_list_entry</h3>
  60 <pre class="programlisting">struct udev_list_entry;</pre>
  61 <p>
  62 Opaque object representing one entry in a list. An entry contains
  63 contains a name, and optionally a value.
  64 </p>
  65 </div>
  66 <hr>
  67 <div class="refsect2">
  68 <a name="udev-list-entry-get-next"></a><h3>udev_list_entry_get_next ()</h3>
  69 <pre class="programlisting">struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * udev_list_entry_get_next       (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</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_entry</code></em> :</span></p></td>
  75 <td>current entry</td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  79 <td>the next entry from the list, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> is no more entries are found.</td>
  80 </tr>
  81 </tbody>
  82 </table></div>
  83 </div>
  84 <hr>
  85 <div class="refsect2">
  86 <a name="udev-list-entry-get-by-name"></a><h3>udev_list_entry_get_by_name ()</h3>
  87 <pre class="programlisting">struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * udev_list_entry_get_by_name    (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>,
  88                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
  89 <div class="variablelist"><table border="0">
  90 <col align="left" valign="top">
  91 <tbody>
  92 <tr>
  93 <td><p><span class="term"><em class="parameter"><code>list_entry</code></em> :</span></p></td>
  94 <td>current entry</td>
  95 </tr>
  96 <tr>
  97 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
  98 <td>name string to match</td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 102 <td>the entry where <em class="parameter"><code>name</code></em> matched, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if no matching entry is found.</td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="udev-list-entry-get-name"></a><h3>udev_list_entry_get_name ()</h3>
 110 <pre class="programlisting">const <span class="returnvalue">char</span> *        udev_list_entry_get_name            (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>);</pre>
 111 <div class="variablelist"><table border="0">
 112 <col align="left" valign="top">
 113 <tbody>
 114 <tr>
 115 <td><p><span class="term"><em class="parameter"><code>list_entry</code></em> :</span></p></td>
 116 <td>current entry</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 120 <td>the name string of this entry.</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="udev-list-entry-get-value"></a><h3>udev_list_entry_get_value ()</h3>
 128 <pre class="programlisting">const <span class="returnvalue">char</span> *        udev_list_entry_get_value           (<em class="parameter"><code><span class="type">struct udev_list_entry</span> *list_entry</code></em>);</pre>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>list_entry</code></em> :</span></p></td>
 134 <td>current entry</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>the value string of this entry.</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="udev-list-entry-foreach"></a><h3>udev_list_entry_foreach()</h3>
 146 <pre class="programlisting">#define             udev_list_entry_foreach(list_entry, first_entry)</pre>
 147 <p>
 148 Helper to iterate over all entries of a list.
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>list_entry</code></em> :</span></p></td>
 155 <td>entry to store the current position</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><em class="parameter"><code>first_entry</code></em> :</span></p></td>
 159 <td>first entry to start with</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 </div>
 165 </div>
 166 <div class="footer">
 167 <hr>
 168           Generated by GTK-Doc V1.18</div>
 169 </body>
 170 </html>