man/udev_list_entry.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2015 David Herrmann <dh.herrmann@gmail.com>
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="udev_list_entry"
  28   xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>udev_list_entry</title>
  32     <productname>systemd</productname>
  33
  34     <authorgroup>
  35       <author>
  36         <contrib>Developer</contrib>
  37         <firstname>David</firstname>
  38         <surname>Herrmann</surname>
  39         <email>dh.herrmann@gmail.com</email>
  40       </author>
  41     </authorgroup>
  42   </refentryinfo>
  43
  44   <refmeta>
  45     <refentrytitle>udev_list_entry</refentrytitle>
  46     <manvolnum>3</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>udev_list_entry</refname>
  51     <refname>udev_list_entry_get_next</refname>
  52     <refname>udev_list_entry_get_by_name</refname>
  53     <refname>udev_list_entry_get_name</refname>
  54     <refname>udev_list_entry_get_value</refname>
  55
  56     <refpurpose>Iterate and access udev lists</refpurpose>
  57   </refnamediv>
  58
  59   <refsynopsisdiv>
  60     <funcsynopsis>
  61       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  62
  63       <funcprototype>
  64         <funcdef>struct udev_list_entry *<function>udev_list_entry_get_next</function></funcdef>
  65         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  66       </funcprototype>
  67
  68       <funcprototype>
  69         <funcdef>struct udev_list_entry *<function>udev_list_entry_get_by_name</function></funcdef>
  70         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  71         <paramdef>const char *<parameter>name</parameter></paramdef>
  72       </funcprototype>
  73
  74       <funcprototype>
  75         <funcdef>const char *<function>udev_list_entry_get_name</function></funcdef>
  76         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  77       </funcprototype>
  78
  79       <funcprototype>
  80         <funcdef>const char *<function>udev_list_entry_get_value</function></funcdef>
  81         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  82       </funcprototype>
  83
  84     </funcsynopsis>
  85   </refsynopsisdiv>
  86
  87   <!--<refsect1>
  88     <title>Description</title>
  89
  90     <para>XXX: Add short description.</para>
  91   </refsect1>-->
  92
  93   <refsect1>
  94     <title>Return Value</title>
  95
  96     <para>On success,
  97     <function>udev_list_entry_get_next()</function> and
  98     <function>udev_list_entry_get_by_name()</function> return
  99     a pointer to the requested list entry. If no such entry can
 100     be found, or on failure, <constant>NULL</constant> is
 101     returned.</para>
 102
 103     <para>On success,
 104     <function>udev_list_entry_get_name()</function> and
 105     <function>udev_list_entry_get_value()</function> return a
 106     pointer to a constant string representing the requested value.
 107     The string is bound to the lifetime of the list entry itself.
 108     On failure, <constant>NULL</constant> is returned.</para>
 109   </refsect1>
 110
 111   <refsect1>
 112     <title>See Also</title>
 113
 114     <para>
 115       <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 116       <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 117       <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 118       <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 119       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 120     </para>
 121   </refsect1>
 122
 123 </refentry>