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