172 lines
8.3 KiB
HTML
172 lines
8.3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: uvw::fs_helper Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="structuvw_1_1fs__helper.html">fs_helper</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="structuvw_1_1fs__helper-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::fs_helper Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Helper functions.
|
|
<a href="structuvw_1_1fs__helper.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="fs_8h_source.html">fs.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a396e5342610a8ba469a5696a44d704f9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__helper.html#a396e5342610a8ba469a5696a44d704f9">handle</a> (<a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> file) noexcept</td></tr>
|
|
<tr class="memdesc:a396e5342610a8ba469a5696a44d704f9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the OS dependent handle. <br /></td></tr>
|
|
<tr class="separator:a396e5342610a8ba469a5696a44d704f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a687b749eb4b571f06accc3274377a48f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1fs__helper.html#a687b749eb4b571f06accc3274377a48f">open</a> (<a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> descriptor) noexcept</td></tr>
|
|
<tr class="memdesc:a687b749eb4b571f06accc3274377a48f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the file descriptor. <br /></td></tr>
|
|
<tr class="separator:a687b749eb4b571f06accc3274377a48f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Helper functions. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fs_8h_source.html#l01203">1203</a> of file <a class="el" href="fs_8h_source.html">fs.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a396e5342610a8ba469a5696a44d704f9" name="a396e5342610a8ba469a5696a44d704f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a396e5342610a8ba469a5696a44d704f9">◆ </a></span>handle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> uvw::fs_helper::handle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> </td>
|
|
<td class="paramname"><em>file</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the OS dependent handle. </p>
|
|
<p>For a file descriptor in the C runtime, get the OS-dependent handle. On UNIX, returns the file descriptor as-is. On Windows, this calls a system function.<br />
|
|
Note that the return value is still owned by the C runtime, any attempts to close it or to use it after closing the file descriptor may lead to malfunction. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a687b749eb4b571f06accc3274377a48f" name="a687b749eb4b571f06accc3274377a48f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a687b749eb4b571f06accc3274377a48f">◆ </a></span>open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> uvw::fs_helper::open </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> </td>
|
|
<td class="paramname"><em>descriptor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the file descriptor. </p>
|
|
<p>For a OS-dependent handle, get the file descriptor in the C runtime. On UNIX, returns the file descriptor as-is. On Windows, this calls a system function.<br />
|
|
Note that the return value is still owned by the C runtime, any attempts to close it or to use it after closing the handle may lead to malfunction. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="fs_8h_source.html">fs.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|