]>
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 | <!-- | |
9 | This file is part of systemd. | |
10 | ||
11 | Copyright 2015 David Herrmann <dh.herrmann@gmail.com> | |
12 | ||
13 | systemd is free software; you can redistribute it and/or modify it | |
14 | under the terms of the GNU Lesser General Public License as published by | |
15 | the Free Software Foundation; either version 2.1 of the License, or | |
16 | (at your option) any later version. | |
17 | ||
18 | systemd is distributed in the hope that it will be useful, but | |
19 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
21 | Lesser General Public License for more details. | |
22 | ||
23 | You should have received a copy of the GNU Lesser General Public License | |
24 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
25 | --> | |
26 | ||
27 | <refentry id="udev_enumerate_new" | |
28 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
29 | ||
30 | <refentryinfo> | |
31 | <title>udev_enumerate_new</title> | |
32 | <productname>systemd</productname> | |
33 | ||
34 | <authorgroup> | |
35 | <author> | |
36 | <contrib>Developer</contrib> | |
37 | <firstname>David</firstname> | |
38 | <surname>Herrmann</surname> | |
39 | <email>dh.herrmann@gmail.com</email> | |
40 | </author> | |
41 | </authorgroup> | |
42 | </refentryinfo> | |
43 | ||
44 | <refmeta> | |
45 | <refentrytitle>udev_enumerate_new</refentrytitle> | |
46 | <manvolnum>3</manvolnum> | |
47 | </refmeta> | |
48 | ||
49 | <refnamediv> | |
50 | <refname>udev_enumerate_new</refname> | |
51 | <refname>udev_enumerate_ref</refname> | |
52 | <refname>udev_enumerate_unref</refname> | |
53 | ||
54 | <refpurpose>Create, acquire and release a udev enumerate object</refpurpose> | |
55 | </refnamediv> | |
56 | ||
57 | <refsynopsisdiv> | |
58 | <funcsynopsis> | |
59 | <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> | |
60 | ||
61 | <funcprototype> | |
62 | <funcdef>struct udev_enumerate *<function>udev_enumerate_new</function></funcdef> | |
63 | <paramdef>struct udev *<parameter>udev</parameter></paramdef> | |
64 | </funcprototype> | |
65 | ||
66 | <funcprototype> | |
67 | <funcdef>struct udev_enumerate *<function>udev_enumerate_ref</function></funcdef> | |
68 | <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef> | |
69 | </funcprototype> | |
70 | ||
71 | <funcprototype> | |
72 | <funcdef>struct udev_enumerate *<function>udev_enumerate_unref</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, <function>udev_enumerate_new()</function> returns a | |
89 | pointer to the allocated udev monitor. On failure, | |
90 | <constant>NULL</constant> is returned. | |
91 | <function>udev_enumerate_ref()</function> returns the argument | |
92 | that it was passed, unmodified. | |
93 | <function>udev_enumerate_unref()</function> always returns | |
94 | <constant>NULL</constant>.</para> | |
95 | </refsect1> | |
96 | ||
97 | <refsect1> | |
98 | <title>See Also</title> | |
99 | ||
100 | <para> | |
101 | <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
102 | <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
103 | <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
104 | <citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
105 | <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
106 | <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
107 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
108 | </para> | |
109 | </refsect1> | |
110 | ||
111 | </refentry> |