/usr/share/doc/libratbag-dev/html/structratbag__interface.html is in libratbag-doc 0.9-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<script type="text/javascript" src="file:///usr/share/javascript/jquery/jquery.js"></script>
<title>libratbag: ratbag_interface Struct Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="file:///usr/share/javascript/mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link href="bootstrap.css" rel="stylesheet" type="text/css"/>
<link href="bootstrap.css" rel="stylesheet" type="text/css" />
<script src="file:///usr/share/javascript/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">libratbag 0.9.0</a>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ratbag_interface Struct Reference<div class="ingroups"><a class="el" href="group__base.html">Initialization and manipulation of ratbag contexts</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>libratbag does not open file descriptors to devices directly, instead <a class="el" href="structratbag__interface.html#a7625875340ab631722a6717a975d02bd" title="Open the device at the given path with the flags provided and return the fd. ">open_restricted()</a> and <a class="el" href="structratbag__interface.html#a5ccac29e0114151d12aba7f4acb82491" title="Close the file descriptor. ">close_restricted()</a> are called for each path that must be opened.
<a href="structratbag__interface.html#details">More...</a></p>
<p><code>#include <<a class="el" href="libratbag_8h_source.html">libratbag.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7625875340ab631722a6717a975d02bd"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__interface.html#a7625875340ab631722a6717a975d02bd">open_restricted</a> )(const char *path, int flags, void *user_data)</td></tr>
<tr class="memdesc:a7625875340ab631722a6717a975d02bd"><td class="mdescLeft"> </td><td class="mdescRight">Open the device at the given path with the flags provided and return the fd. <a href="#a7625875340ab631722a6717a975d02bd">More...</a><br /></td></tr>
<tr class="separator:a7625875340ab631722a6717a975d02bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ccac29e0114151d12aba7f4acb82491"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__interface.html#a5ccac29e0114151d12aba7f4acb82491">close_restricted</a> )(int fd, void *user_data)</td></tr>
<tr class="memdesc:a5ccac29e0114151d12aba7f4acb82491"><td class="mdescLeft"> </td><td class="mdescRight">Close the file descriptor. <a href="#a5ccac29e0114151d12aba7f4acb82491">More...</a><br /></td></tr>
<tr class="separator:a5ccac29e0114151d12aba7f4acb82491"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>libratbag does not open file descriptors to devices directly, instead <a class="el" href="structratbag__interface.html#a7625875340ab631722a6717a975d02bd" title="Open the device at the given path with the flags provided and return the fd. ">open_restricted()</a> and <a class="el" href="structratbag__interface.html#a5ccac29e0114151d12aba7f4acb82491" title="Close the file descriptor. ">close_restricted()</a> are called for each path that must be opened. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__base.html#ga3394131f8d3dda1d29bec9384a9ca903" title="Create a new ratbag context. ">ratbag_create_context</a> </dd></dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5ccac29e0114151d12aba7f4acb82491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ccac29e0114151d12aba7f4acb82491">◆ </a></span>close_restricted</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* ratbag_interface::close_restricted) (int fd, void *user_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the file descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The file descriptor to close </td></tr>
<tr><td class="paramname">user_data</td><td>The user_data provided in <a class="el" href="group__base.html#ga3394131f8d3dda1d29bec9384a9ca903" title="Create a new ratbag context. ">ratbag_create_context()</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7625875340ab631722a6717a975d02bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7625875340ab631722a6717a975d02bd">◆ </a></span>open_restricted</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* ratbag_interface::open_restricted) (const char *path, int flags, void *user_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the device at the given path with the flags provided and return the fd. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The device path to open </td></tr>
<tr><td class="paramname">flags</td><td>Flags as defined by open(2) </td></tr>
<tr><td class="paramname">user_data</td><td>The user_data provided in <a class="el" href="group__base.html#ga3394131f8d3dda1d29bec9384a9ca903" title="Create a new ratbag context. ">ratbag_create_context()</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The file descriptor, or a negative errno on failure. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/build/libratbag-1ltGPZ/libratbag-0.9/src/<a class="el" href="libratbag_8h_source.html">libratbag.h</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 10 2018 18:56:06 for libratbag by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|