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   SPDX-License-Identifier: LGPL-2.1+
  10 -->
  11
  12 <refentry id="udev_list_entry"
  13   xmlns:xi="http://www.w3.org/2001/XInclude">
  14
  15   <refentryinfo>
  16     <title>udev_list_entry</title>
  17     <productname>systemd</productname>
  18   </refentryinfo>
  19
  20   <refmeta>
  21     <refentrytitle>udev_list_entry</refentrytitle>
  22     <manvolnum>3</manvolnum>
  23   </refmeta>
  24
  25   <refnamediv>
  26     <refname>udev_list_entry</refname>
  27     <refname>udev_list_entry_get_next</refname>
  28     <refname>udev_list_entry_get_by_name</refname>
  29     <refname>udev_list_entry_get_name</refname>
  30     <refname>udev_list_entry_get_value</refname>
  31
  32     <refpurpose>Iterate and access udev lists</refpurpose>
  33   </refnamediv>
  34
  35   <refsynopsisdiv>
  36     <funcsynopsis>
  37       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  38
  39       <funcprototype>
  40         <funcdef>struct udev_list_entry *<function>udev_list_entry_get_next</function></funcdef>
  41         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  42       </funcprototype>
  43
  44       <funcprototype>
  45         <funcdef>struct udev_list_entry *<function>udev_list_entry_get_by_name</function></funcdef>
  46         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  47         <paramdef>const char *<parameter>name</parameter></paramdef>
  48       </funcprototype>
  49
  50       <funcprototype>
  51         <funcdef>const char *<function>udev_list_entry_get_name</function></funcdef>
  52         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  53       </funcprototype>
  54
  55       <funcprototype>
  56         <funcdef>const char *<function>udev_list_entry_get_value</function></funcdef>
  57         <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef>
  58       </funcprototype>
  59
  60     </funcsynopsis>
  61   </refsynopsisdiv>
  62
  63   <!--<refsect1>
  64     <title>Description</title>
  65
  66     <para>XXX: Add short description.</para>
  67   </refsect1>-->
  68
  69   <refsect1>
  70     <title>Return Value</title>
  71
  72     <para>On success,
  73     <function>udev_list_entry_get_next()</function> and
  74     <function>udev_list_entry_get_by_name()</function> return
  75     a pointer to the requested list entry. If no such entry can
  76     be found, or on failure, <constant>NULL</constant> is
  77     returned.</para>
  78
  79     <para>On success,
  80     <function>udev_list_entry_get_name()</function> and
  81     <function>udev_list_entry_get_value()</function> return a
  82     pointer to a constant string representing the requested value.
  83     The string is bound to the lifetime of the list entry itself.
  84     On failure, <constant>NULL</constant> is returned.</para>
  85   </refsect1>
  86
  87   <refsect1>
  88     <title>See Also</title>
  89
  90     <para>
  91       <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  92       <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  94       <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  95       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  96     </para>
  97   </refsect1>
  98
  99 </refentry>