]>
Commit | Line | Data |
---|---|---|
06255d6f DH |
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 | <!-- | |
572eb058 | 9 | SPDX-License-Identifier: LGPL-2.1+ |
06255d6f DH |
10 | --> |
11 | ||
12 | <refentry id="udev_enumerate_scan_devices" | |
13 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
14 | ||
15 | <refentryinfo> | |
16 | <title>udev_enumerate_scan_devices</title> | |
17 | <productname>systemd</productname> | |
06255d6f DH |
18 | </refentryinfo> |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>udev_enumerate_scan_devices</refentrytitle> | |
22 | <manvolnum>3</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>udev_enumerate_scan_devices</refname> | |
27 | <refname>udev_enumerate_scan_subsystems</refname> | |
28 | <refname>udev_enumerate_get_list_entry</refname> | |
29 | <refname>udev_enumerate_add_syspath</refname> | |
30 | <refname>udev_enumerate_get_udev</refname> | |
31 | ||
32 | <refpurpose>Query or modify a udev enumerate object</refpurpose> | |
33 | </refnamediv> | |
34 | ||
35 | <refsynopsisdiv> | |
36 | <funcsynopsis> | |
37 | <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> | |
38 | ||
39 | <funcprototype> | |
40 | <funcdef>int <function>udev_enumerate_scan_devices</function></funcdef> | |
41 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
42 | </funcprototype> | |
43 | ||
44 | <funcprototype> | |
45 | <funcdef>int <function>udev_enumerate_scan_subsystems</function></funcdef> | |
46 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
47 | </funcprototype> | |
48 | ||
49 | <funcprototype> | |
50 | <funcdef>struct udev_list_entry *<function>udev_enumerate_get_list_entry</function></funcdef> | |
51 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
52 | </funcprototype> | |
53 | ||
54 | <funcprototype> | |
55 | <funcdef>int <function>udev_enumerate_add_syspath</function></funcdef> | |
56 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
57 | <paramdef>const char *<parameter>syspath</parameter></paramdef> | |
58 | </funcprototype> | |
59 | ||
60 | <funcprototype> | |
61 | <funcdef>struct udev *<function>udev_enumerate_get_udev</function></funcdef> | |
62 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
63 | </funcprototype> | |
64 | ||
65 | </funcsynopsis> | |
66 | </refsynopsisdiv> | |
67 | ||
68 | <!--<refsect1> | |
69 | <title>Description</title> | |
70 | ||
71 | <para>XXX: Add short description.</para> | |
72 | </refsect1>--> | |
73 | ||
74 | <refsect1> | |
75 | <title>Return Value</title> | |
76 | ||
77 | <para>On success, | |
78 | <function>udev_enumerate_scan_devices()</function>, | |
79 | <function>udev_enumerate_scan_subsystems()</function> and | |
80 | <function>udev_enumerate_add_syspath()</function> | |
81 | return an integer greater than, or equal to, | |
82 | <constant>0</constant>.</para> | |
83 | ||
84 | <para>On success, | |
85 | <function>udev_enumerate_get_list_entry()</function> | |
86 | returns a pointer to the first entry in the list of found | |
87 | devices. If the list is empty, or on failure, | |
88 | <constant>NULL</constant> is returned.</para> | |
89 | ||
90 | <para><function>udev_enumerate_get_udev()</function> always | |
a8eaaee7 | 91 | returns a pointer to the udev context that this enumerated |
06255d6f DH |
92 | object is associated with.</para> |
93 | </refsect1> | |
94 | ||
95 | <refsect1> | |
96 | <title>See Also</title> | |
97 | ||
98 | <para> | |
99 | <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
100 | <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
101 | <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
102 | <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
103 | <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
104 | <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
105 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
106 | </para> | |
107 | </refsect1> | |
108 | ||
109 | </refentry> |