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