1<?xml version='1.0'?> <!--*-nxml-*--> 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ 4<!ENTITY % entities SYSTEM "custom-entities.ent" > 5%entities; 6]> 7<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> 8 9<refentry id="udev_enumerate_scan_devices" 10 xmlns:xi="http://www.w3.org/2001/XInclude"> 11 12 <refentryinfo> 13 <title>udev_enumerate_scan_devices</title> 14 <productname>systemd</productname> 15 </refentryinfo> 16 17 <refmeta> 18 <refentrytitle>udev_enumerate_scan_devices</refentrytitle> 19 <manvolnum>3</manvolnum> 20 </refmeta> 21 22 <refnamediv> 23 <refname>udev_enumerate_scan_devices</refname> 24 <refname>udev_enumerate_scan_subsystems</refname> 25 <refname>udev_enumerate_get_list_entry</refname> 26 <refname>udev_enumerate_add_syspath</refname> 27 <refname>udev_enumerate_get_udev</refname> 28 29 <refpurpose>Query or modify a udev enumerate object</refpurpose> 30 </refnamediv> 31 32 <refsynopsisdiv> 33 <funcsynopsis> 34 <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> 35 36 <funcprototype> 37 <funcdef>int <function>udev_enumerate_scan_devices</function></funcdef> 38 <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> 39 </funcprototype> 40 41 <funcprototype> 42 <funcdef>int <function>udev_enumerate_scan_subsystems</function></funcdef> 43 <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> 44 </funcprototype> 45 46 <funcprototype> 47 <funcdef>struct udev_list_entry *<function>udev_enumerate_get_list_entry</function></funcdef> 48 <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> 49 </funcprototype> 50 51 <funcprototype> 52 <funcdef>int <function>udev_enumerate_add_syspath</function></funcdef> 53 <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> 54 <paramdef>const char *<parameter>syspath</parameter></paramdef> 55 </funcprototype> 56 57 <funcprototype> 58 <funcdef>struct udev *<function>udev_enumerate_get_udev</function></funcdef> 59 <paramdef>struct udev_enumerate *<parameter>udev_enumerate</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_enumerate_scan_devices()</function>, 76 <function>udev_enumerate_scan_subsystems()</function> and 77 <function>udev_enumerate_add_syspath()</function> 78 return an integer greater than, or equal to, 79 <constant>0</constant>.</para> 80 81 <para>On success, 82 <function>udev_enumerate_get_list_entry()</function> 83 returns a pointer to the first entry in the list of found 84 devices. If the list is empty, or on failure, 85 <constant>NULL</constant> is returned.</para> 86 87 <para><function>udev_enumerate_get_udev()</function> always 88 returns a pointer to the udev context that this enumerated 89 object is associated with.</para> 90 </refsect1> 91 92 <refsect1> 93 <title>See Also</title> 94 95 <para> 96 <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 97 <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 98 <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 99 <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 100 <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 101 <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 102 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, 103 </para> 104 </refsect1> 105 106</refentry> 107