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
  16 <refentry id="udev_enumerate_new"
  17   xmlns:xi="http://www.w3.org/2001/XInclude">
  18
  19   <refentryinfo>
  20     <title>udev_enumerate_new</title>
  21     <productname>systemd</productname>
  22
  23     <authorgroup>
  24       <author>
  25         <contrib>Developer</contrib>
  26         <firstname>David</firstname>
  27         <surname>Herrmann</surname>
  28         <email>dh.herrmann@gmail.com</email>
  29       </author>
  30     </authorgroup>
  31   </refentryinfo>
  32
  33   <refmeta>
  34     <refentrytitle>udev_enumerate_new</refentrytitle>
  35     <manvolnum>3</manvolnum>
  36   </refmeta>
  37
  38   <refnamediv>
  39     <refname>udev_enumerate_new</refname>
  40     <refname>udev_enumerate_ref</refname>
  41     <refname>udev_enumerate_unref</refname>
  42
  43     <refpurpose>Create, acquire and release a udev enumerate object</refpurpose>
  44   </refnamediv>
  45
  46   <refsynopsisdiv>
  47     <funcsynopsis>
  48       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  49
  50       <funcprototype>
  51         <funcdef>struct udev_enumerate *<function>udev_enumerate_new</function></funcdef>
  52         <paramdef>struct udev *<parameter>udev</parameter></paramdef>
  53       </funcprototype>
  54
  55       <funcprototype>
  56         <funcdef>struct udev_enumerate *<function>udev_enumerate_ref</function></funcdef>
  57         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  58       </funcprototype>
  59
  60       <funcprototype>
  61         <funcdef>struct udev_enumerate *<function>udev_enumerate_unref</function></funcdef>
  62         <paramdef>struct udev_enumerate *<parameter>udev_enumerate</parameter></paramdef>
  63       </funcprototype>
  64
  65     </funcsynopsis>
  66   </refsynopsisdiv>
  67
  68   <!--<refsect1>
  69     <title>Description</title>
  70
  71     <para>XXX: Add short description.</para>
  72   </refsect1>-->
  73
  74   <refsect1>
  75     <title>Return Value</title>
  76
  77     <para>On success, <function>udev_enumerate_new()</function> returns a
  78     pointer to the allocated udev monitor. On failure,
  79     <constant>NULL</constant> is returned.
  80     <function>udev_enumerate_ref()</function> returns the argument
  81     that it was passed, unmodified.
  82     <function>udev_enumerate_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_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  94       <citerefentry><refentrytitle>udev_monitor_new_from_netlink</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>