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