]>
Commit | Line | Data |
---|---|---|
06255d6f | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
06255d6f DH |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > | |
5 | %entities; | |
6 | ]> | |
db9ecf05 | 7 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
06255d6f DH |
8 | |
9 | <refentry id="udev_list_entry" | |
10 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
11 | ||
12 | <refentryinfo> | |
13 | <title>udev_list_entry</title> | |
14 | <productname>systemd</productname> | |
06255d6f DH |
15 | </refentryinfo> |
16 | ||
17 | <refmeta> | |
18 | <refentrytitle>udev_list_entry</refentrytitle> | |
19 | <manvolnum>3</manvolnum> | |
20 | </refmeta> | |
21 | ||
22 | <refnamediv> | |
23 | <refname>udev_list_entry</refname> | |
24 | <refname>udev_list_entry_get_next</refname> | |
25 | <refname>udev_list_entry_get_by_name</refname> | |
26 | <refname>udev_list_entry_get_name</refname> | |
27 | <refname>udev_list_entry_get_value</refname> | |
28 | ||
29 | <refpurpose>Iterate and access udev lists</refpurpose> | |
30 | </refnamediv> | |
31 | ||
32 | <refsynopsisdiv> | |
33 | <funcsynopsis> | |
34 | <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> | |
35 | ||
36 | <funcprototype> | |
37 | <funcdef>struct udev_list_entry *<function>udev_list_entry_get_next</function></funcdef> | |
38 | <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef> | |
39 | </funcprototype> | |
40 | ||
41 | <funcprototype> | |
42 | <funcdef>struct udev_list_entry *<function>udev_list_entry_get_by_name</function></funcdef> | |
43 | <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef> | |
44 | <paramdef>const char *<parameter>name</parameter></paramdef> | |
45 | </funcprototype> | |
46 | ||
47 | <funcprototype> | |
48 | <funcdef>const char *<function>udev_list_entry_get_name</function></funcdef> | |
49 | <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef> | |
50 | </funcprototype> | |
51 | ||
52 | <funcprototype> | |
53 | <funcdef>const char *<function>udev_list_entry_get_value</function></funcdef> | |
54 | <paramdef>struct udev_list_entry *<parameter>list_entry</parameter></paramdef> | |
55 | </funcprototype> | |
56 | ||
57 | </funcsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <!--<refsect1> | |
61 | <title>Description</title> | |
62 | ||
63 | <para>XXX: Add short description.</para> | |
64 | </refsect1>--> | |
65 | ||
66 | <refsect1> | |
67 | <title>Return Value</title> | |
68 | ||
69 | <para>On success, | |
70 | <function>udev_list_entry_get_next()</function> and | |
71 | <function>udev_list_entry_get_by_name()</function> return | |
72 | a pointer to the requested list entry. If no such entry can | |
73 | be found, or on failure, <constant>NULL</constant> is | |
74 | returned.</para> | |
75 | ||
76 | <para>On success, | |
77 | <function>udev_list_entry_get_name()</function> and | |
78 | <function>udev_list_entry_get_value()</function> return a | |
79 | pointer to a constant string representing the requested value. | |
b938cb90 | 80 | The string is bound to the lifetime of the list entry itself. |
06255d6f DH |
81 | On failure, <constant>NULL</constant> is returned.</para> |
82 | </refsect1> | |
83 | ||
84 | <refsect1> | |
85 | <title>See Also</title> | |
86 | ||
87 | <para> | |
88 | <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
89 | <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
90 | <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
91 | <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
92 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
93 | </para> | |
94 | </refsect1> | |
95 | ||
96 | </refentry> |