man/udev_monitor_new_from_netlink.xml

   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   SPDX-License-Identifier: LGPL-2.1+
  10 -->
  11
  12 <refentry id="udev_monitor_new_from_netlink"
  13   xmlns:xi="http://www.w3.org/2001/XInclude">
  14
  15   <refentryinfo>
  16     <title>udev_monitor_new_from_netlink</title>
  17     <productname>systemd</productname>
  18   </refentryinfo>
  19
  20   <refmeta>
  21     <refentrytitle>udev_monitor_new_from_netlink</refentrytitle>
  22     <manvolnum>3</manvolnum>
  23   </refmeta>
  24
  25   <refnamediv>
  26     <refname>udev_monitor_new_from_netlink</refname>
  27     <refname>udev_monitor_ref</refname>
  28     <refname>udev_monitor_unref</refname>
  29
  30     <refpurpose>Create, acquire and release a udev monitor object</refpurpose>
  31   </refnamediv>
  32
  33   <refsynopsisdiv>
  34     <funcsynopsis>
  35       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  36
  37       <funcprototype>
  38         <funcdef>struct udev_monitor *<function>udev_monitor_new_from_netlink</function></funcdef>
  39         <paramdef>struct udev *<parameter>udev</parameter></paramdef>
  40         <paramdef>const char *<parameter>name</parameter></paramdef>
  41       </funcprototype>
  42
  43       <funcprototype>
  44         <funcdef>struct udev_monitor *<function>udev_monitor_ref</function></funcdef>
  45         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  46       </funcprototype>
  47
  48       <funcprototype>
  49         <funcdef>struct udev_monitor *<function>udev_monitor_unref</function></funcdef>
  50         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  51       </funcprototype>
  52
  53     </funcsynopsis>
  54   </refsynopsisdiv>
  55
  56   <!--<refsect1>
  57     <title>Description</title>
  58
  59     <para>XXX: Add short description.</para>
  60   </refsect1>-->
  61
  62   <refsect1>
  63     <title>Return Value</title>
  64
  65     <para>On success,
  66     <function>udev_monitor_new_from_netlink()</function> returns a
  67     pointer to the allocated udev monitor. On failure,
  68     <constant>NULL</constant> is returned.
  69     <function>udev_monitor_ref()</function> returns the argument
  70     that it was passed, unmodified.
  71     <function>udev_monitor_unref()</function> always returns
  72     <constant>NULL</constant>.</para>
  73   </refsect1>
  74
  75   <refsect1>
  76     <title>See Also</title>
  77
  78     <para>
  79       <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  80       <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  81       <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  82       <citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  83       <citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  84       <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  85       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  86     </para>
  87   </refsect1>
  88
  89 </refentry>