man/udev_enumerate_scan_devices.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_enumerate_scan_devices"
  28   xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>udev_enumerate_scan_devices</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_enumerate_scan_devices</refentrytitle>
  46     <manvolnum>3</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>udev_enumerate_scan_devices</refname>
  51     <refname>udev_enumerate_scan_subsystems</refname>
  52     <refname>udev_enumerate_get_list_entry</refname>
  53     <refname>udev_enumerate_add_syspath</refname>
  54     <refname>udev_enumerate_get_udev</refname>
  55
  56     <refpurpose>Query or modify a udev enumerate object</refpurpose>
  57   </refnamediv>
  58
  59   <refsynopsisdiv>
  60     <funcsynopsis>
  61       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  62
  63       <funcprototype>
  64         <funcdef>int <function>udev_enumerate_scan_devices</function></funcdef>
  65         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  66       </funcprototype>
  67
  68       <funcprototype>
  69         <funcdef>int <function>udev_enumerate_scan_subsystems</function></funcdef>
  70         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  71       </funcprototype>
  72
  73       <funcprototype>
  74         <funcdef>struct udev_list_entry *<function>udev_enumerate_get_list_entry</function></funcdef>
  75         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  76       </funcprototype>
  77
  78       <funcprototype>
  79         <funcdef>int <function>udev_enumerate_add_syspath</function></funcdef>
  80         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  81         <paramdef>const char *<parameter>syspath</parameter></paramdef>
  82       </funcprototype>
  83
  84       <funcprototype>
  85         <funcdef>struct udev *<function>udev_enumerate_get_udev</function></funcdef>
  86         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  87       </funcprototype>
  88
  89     </funcsynopsis>
  90   </refsynopsisdiv>
  91
  92   <!--<refsect1>
  93     <title>Description</title>
  94
  95     <para>XXX: Add short description.</para>
  96   </refsect1>-->
  97
  98   <refsect1>
  99     <title>Return Value</title>
 100
 101     <para>On success,
 102     <function>udev_enumerate_scan_devices()</function>,
 103     <function>udev_enumerate_scan_subsystems()</function> and
 104     <function>udev_enumerate_add_syspath()</function>
 105     return an integer greater than, or equal to,
 106     <constant>0</constant>.</para>
 107
 108     <para>On success,
 109     <function>udev_enumerate_get_list_entry()</function>
 110     returns a pointer to the first entry in the list of found
 111     devices. If the list is empty, or on failure,
 112     <constant>NULL</constant> is returned.</para>
 113
 114     <para><function>udev_enumerate_get_udev()</function> always
 115     returns a pointer to the udev context that this enumerated
 116     object is associated with.</para>
 117   </refsect1>
 118
 119   <refsect1>
 120     <title>See Also</title>
 121
 122     <para>
 123       <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 124       <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 125       <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 126       <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 127       <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 128       <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 129       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 130     </para>
 131   </refsect1>
 132
 133 </refentry>