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