]>
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_new" | |
15 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
16 | ||
17 | <refentryinfo> | |
18 | <title>udev_enumerate_new</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_new</refentrytitle> | |
33 | <manvolnum>3</manvolnum> | |
34 | </refmeta> | |
35 | ||
36 | <refnamediv> | |
37 | <refname>udev_enumerate_new</refname> | |
38 | <refname>udev_enumerate_ref</refname> | |
39 | <refname>udev_enumerate_unref</refname> | |
40 | ||
41 | <refpurpose>Create, acquire and release a udev enumerate object</refpurpose> | |
42 | </refnamediv> | |
43 | ||
44 | <refsynopsisdiv> | |
45 | <funcsynopsis> | |
46 | <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> | |
47 | ||
48 | <funcprototype> | |
49 | <funcdef>struct udev_enumerate *<function>udev_enumerate_new</function></funcdef> | |
50 | <paramdef>struct udev *<parameter>udev</parameter></paramdef> | |
51 | </funcprototype> | |
52 | ||
53 | <funcprototype> | |
54 | <funcdef>struct udev_enumerate *<function>udev_enumerate_ref</function></funcdef> | |
55 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
56 | </funcprototype> | |
57 | ||
58 | <funcprototype> | |
59 | <funcdef>struct udev_enumerate *<function>udev_enumerate_unref</function></funcdef> | |
60 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
61 | </funcprototype> | |
62 | ||
63 | </funcsynopsis> | |
64 | </refsynopsisdiv> | |
65 | ||
66 | <!--<refsect1> | |
67 | <title>Description</title> | |
68 | ||
69 | <para>XXX: Add short description.</para> | |
70 | </refsect1>--> | |
71 | ||
72 | <refsect1> | |
73 | <title>Return Value</title> | |
74 | ||
75 | <para>On success, <function>udev_enumerate_new()</function> returns a | |
76 | pointer to the allocated udev monitor. On failure, | |
77 | <constant>NULL</constant> is returned. | |
78 | <function>udev_enumerate_ref()</function> returns the argument | |
79 | that it was passed, unmodified. | |
80 | <function>udev_enumerate_unref()</function> always returns | |
81 | <constant>NULL</constant>.</para> | |
82 | </refsect1> | |
83 | ||
84 | <refsect1> | |
85 | <title>See Also</title> | |
86 | ||
87 | <para> | |
88 | <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
89 | <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
90 | <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
91 | <citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
92 | <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
93 | <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
94 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
95 | </para> | |
96 | </refsect1> | |
97 | ||
98 | </refentry> |