systemd/man/udev_monitor_new_from_netlink.xml
2023-09-25 22:29:38 +01:00

94 lines
3.3 KiB
XML

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="udev_monitor_new_from_netlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>udev_monitor_new_from_netlink</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>udev_monitor_new_from_netlink</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>udev_monitor_new_from_netlink</refname>
<refname>udev_monitor_ref</refname>
<refname>udev_monitor_unref</refname>
<refpurpose>Create, acquire and release a udev monitor object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>struct udev_monitor *<function>udev_monitor_new_from_netlink</function></funcdef>
<paramdef>struct udev *<parameter>udev</parameter></paramdef>
<paramdef>const char *<parameter>name</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>struct udev_monitor *<function>udev_monitor_ref</function></funcdef>
<paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>struct udev_monitor *<function>udev_monitor_unref</function></funcdef>
<paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!--<refsect1>
<title>Description</title>
<para>XXX: Add short description.</para>
</refsect1>-->
<refsect1>
<title>Return Value</title>
<para>On success,
<function>udev_monitor_new_from_netlink()</function> returns a
pointer to the allocated udev monitor. On failure,
<constant>NULL</constant> is returned.
<function>udev_monitor_ref()</function> returns the argument
that it was passed, unmodified.
<function>udev_monitor_unref()</function> always returns
<constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<title>History</title>
<para><function>udev_monitor_new_from_netlink()</function>,
<function>udev_monitor_ref()</function>, and
<function>udev_monitor_unref()</function> were added in version 221.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>