man/udev_monitor_new_from_netlink.xml

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