]>
Commit | Line | Data |
---|---|---|
06255d6f DH |
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 | <!-- | |
572eb058 ZJS |
9 | SPDX-License-Identifier: LGPL-2.1+ |
10 | ||
96b2fb93 | 11 | Copyright © 2015 David Herrmann <dh.herrmann@gmail.com> |
06255d6f DH |
12 | --> |
13 | ||
14 | <refentry id="udev_device_has_tag" | |
15 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
16 | ||
17 | <refentryinfo> | |
18 | <title>udev_device_has_tag</title> | |
19 | <productname>systemd</productname> | |
06255d6f DH |
20 | </refentryinfo> |
21 | ||
22 | <refmeta> | |
23 | <refentrytitle>udev_device_has_tag</refentrytitle> | |
24 | <manvolnum>3</manvolnum> | |
25 | </refmeta> | |
26 | ||
27 | <refnamediv> | |
28 | <refname>udev_device_has_tag</refname> | |
29 | <refname>udev_device_get_devlinks_list_entry</refname> | |
30 | <refname>udev_device_get_properties_list_entry</refname> | |
31 | <refname>udev_device_get_tags_list_entry</refname> | |
32 | <refname>udev_device_get_sysattr_list_entry</refname> | |
33 | <refname>udev_device_get_property_value</refname> | |
34 | <refname>udev_device_get_sysattr_value</refname> | |
35 | <refname>udev_device_set_sysattr_value</refname> | |
36 | ||
37 | <refpurpose>Retrieve or set device attributes</refpurpose> | |
38 | </refnamediv> | |
39 | ||
40 | <refsynopsisdiv> | |
41 | <funcsynopsis> | |
42 | <funcsynopsisinfo>#include <libudev.h></funcsynopsisinfo> | |
43 | ||
44 | <funcprototype> | |
45 | <funcdef>struct udev_list_entry *<function>udev_device_get_devlinks_list_entry</function></funcdef> | |
46 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
47 | </funcprototype> | |
48 | ||
49 | <funcprototype> | |
50 | <funcdef>struct udev_list_entry *<function>udev_device_get_properties_list_entry</function></funcdef> | |
51 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
52 | </funcprototype> | |
53 | ||
54 | <funcprototype> | |
55 | <funcdef>struct udev_list_entry *<function>udev_device_get_tags_list_entry</function></funcdef> | |
56 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
57 | </funcprototype> | |
58 | ||
59 | <funcprototype> | |
60 | <funcdef>struct udev_list_entry *<function>udev_device_get_sysattr_list_entry</function></funcdef> | |
61 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
62 | </funcprototype> | |
63 | ||
64 | <funcprototype> | |
65 | <funcdef>const char *<function>udev_device_get_property_value</function></funcdef> | |
66 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
67 | <paramdef>const char *<parameter>key</parameter></paramdef> | |
68 | </funcprototype> | |
69 | ||
70 | <funcprototype> | |
71 | <funcdef>int <function>udev_device_has_tag</function></funcdef> | |
72 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
73 | <paramdef>const char *<parameter>tag</parameter></paramdef> | |
74 | </funcprototype> | |
75 | ||
76 | <funcprototype> | |
77 | <funcdef>const char *<function>udev_device_get_sysattr_value</function></funcdef> | |
78 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
79 | <paramdef>const char *<parameter>sysattr</parameter></paramdef> | |
80 | </funcprototype> | |
81 | ||
82 | <funcprototype> | |
83 | <funcdef>int <function>udev_device_set_sysattr_value</function></funcdef> | |
84 | <paramdef>struct udev_device *<parameter>udev_device</parameter></paramdef> | |
85 | <paramdef>const char *<parameter>sysattr</parameter></paramdef> | |
86 | <paramdef>const char *<parameter>value</parameter></paramdef> | |
87 | </funcprototype> | |
88 | ||
89 | </funcsynopsis> | |
90 | </refsynopsisdiv> | |
91 | ||
92 | <!--<refsect1> | |
93 | <title>Description</title> | |
94 | ||
95 | <para>XXX: Add short description.</para> | |
96 | </refsect1>--> | |
97 | ||
98 | <refsect1> | |
99 | <title>Return Value</title> | |
100 | ||
101 | <para>On success, | |
102 | <function>udev_device_get_devlinks_list_entry()</function>, | |
103 | <function>udev_device_get_properties_list_entry()</function>, | |
104 | <function>udev_device_get_tags_list_entry()</function> and | |
105 | <function>udev_device_get_sysattr_list_entry()</function> return | |
106 | a pointer to the first entry of the retrieved list. If that list | |
107 | is empty, or if an error occurred, <constant>NULL</constant> is | |
108 | returned.</para> | |
109 | ||
110 | <para>On success, | |
111 | <function>udev_device_get_property_value()</function> and | |
112 | <function>udev_device_get_sysattr_value()</function> return a | |
113 | pointer to a constant string of the requested value. On error, | |
114 | <constant>NULL</constant> is returned.</para> | |
115 | ||
116 | <para>On success, | |
117 | <function>udev_device_set_sysattr_value()</function> returns | |
118 | an integer greater than, or equal to, <constant>0</constant>. | |
119 | On failure, a negative error code is returned.</para> | |
120 | ||
121 | <para>On success, <function>udev_device_has_tag()</function> | |
122 | returns <constant>1</constant> or <constant>0</constant>, | |
123 | depending on whether the device has the given tag or not. | |
124 | On failure, a negative error code is returned.</para> | |
125 | </refsect1> | |
126 | ||
127 | <refsect1> | |
128 | <title>See Also</title> | |
129 | ||
130 | <para> | |
131 | <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
132 | <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
133 | <citerefentry><refentrytitle>udev_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
134 | <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
135 | <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
136 | <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
137 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
138 | </para> | |
139 | </refsect1> | |
140 | ||
141 | </refentry> |