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