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