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