systemd/docs/libudev/html/libudev-udev-hwdb.html
2014-04-26 10:08:46 +02:00

182 lines
8.8 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>udev_hwdb</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libudev Reference Manual">
<link rel="up" href="ch01.html" title="API Reference">
<link rel="prev" href="libudev-udev-queue.html" title="udev_queue">
<link rel="next" href="libudev-udev-util.html" title="udev_util">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libudev-udev-queue.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libudev Reference Manual</th>
<td><a accesskey="n" href="libudev-udev-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libudev-udev-hwdb.synopsis" class="shortcut">Top</a>
 | 
<a href="#libudev-udev-hwdb.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libudev-udev-hwdb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libudev-udev-hwdb.top_of_page"></a>udev_hwdb</span></h2>
<p>udev_hwdb — retrieve properties from the hardware database</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libudev-udev-hwdb.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb">udev_hwdb</a>;
struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * <a class="link" href="libudev-udev-hwdb.html#udev-hwdb-ref" title="udev_hwdb_ref ()">udev_hwdb_ref</a> (<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>);
struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * <a class="link" href="libudev-udev-hwdb.html#udev-hwdb-unref" title="udev_hwdb_unref ()">udev_hwdb_unref</a> (<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>);
struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * <a class="link" href="libudev-udev-hwdb.html#udev-hwdb-new" title="udev_hwdb_new ()">udev_hwdb_new</a> (<em class="parameter"><code><span class="type">struct udev</span> *udev</code></em>);
struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * <a class="link" href="libudev-udev-hwdb.html#udev-hwdb-get-properties-list-entry" title="udev_hwdb_get_properties_list_entry ()">udev_hwdb_get_properties_list_entry</a>
(<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *modalias</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> flags</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libudev-udev-hwdb.description"></a><h2>Description</h2>
<p>
Libudev hardware database interface.
</p>
</div>
<div class="refsect1">
<a name="libudev-udev-hwdb.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="udev-hwdb"></a><h3>struct udev_hwdb</h3>
<pre class="programlisting">struct udev_hwdb;</pre>
<p>
Opaque object representing the hardware database.
</p>
</div>
<hr>
<div class="refsect2">
<a name="udev-hwdb-ref"></a><h3>udev_hwdb_ref ()</h3>
<pre class="programlisting">struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * udev_hwdb_ref (<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>);</pre>
<p>
Take a reference of a hwdb context.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hwdb</code></em> :</span></p></td>
<td>context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the passed enumeration context</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="udev-hwdb-unref"></a><h3>udev_hwdb_unref ()</h3>
<pre class="programlisting">struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * udev_hwdb_unref (<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>);</pre>
<p>
Drop a reference of a hwdb context. If the refcount reaches zero,
all resources of the hwdb context will be released.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hwdb</code></em> :</span></p></td>
<td>context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the passed hwdb context if it has still an active reference, or <span class="type">NULL</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="udev-hwdb-new"></a><h3>udev_hwdb_new ()</h3>
<pre class="programlisting">struct <a class="link" href="libudev-udev-hwdb.html#udev-hwdb" title="struct udev_hwdb"><span class="returnvalue">udev_hwdb</span></a> * udev_hwdb_new (<em class="parameter"><code><span class="type">struct udev</span> *udev</code></em>);</pre>
<p>
Create a hardware database context to query properties for devices.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>udev</code></em> :</span></p></td>
<td>udev library context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a hwdb context.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="udev-hwdb-get-properties-list-entry"></a><h3>udev_hwdb_get_properties_list_entry ()</h3>
<pre class="programlisting">struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry"><span class="returnvalue">udev_list_entry</span></a> * udev_hwdb_get_properties_list_entry
(<em class="parameter"><code><span class="type">struct udev_hwdb</span> *hwdb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *modalias</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> flags</code></em>);</pre>
<p>
Lookup a matching device in the hardware database. The lookup key is a
modalias string, whose formats are defined for the Linux kernel modules.
Examples are: pci:v00008086d00001C2D*, usb:v04F2pB221*. The first entry
of a list of retrieved properties is returned.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hwdb</code></em> :</span></p></td>
<td>context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modalias</code></em> :</span></p></td>
<td>modalias string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>(unused)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a udev_list_entry.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>