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