326 lines
16 KiB
HTML
326 lines
16 KiB
HTML
<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: uvw::Utilities::OS 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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">uvw
|
|
 <span id="projectnumber">1.3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- 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 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_1Utilities.html">Utilities</a></li><li class="navelem"><a class="el" href="structuvw_1_1Utilities_1_1OS.html">OS</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_1Utilities_1_1OS-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">uvw::Utilities::OS Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="structuvw_1_1Utilities_1_1OS.html" title="OS dedicated utilities. ">OS</a> dedicated utilities.
|
|
<a href="structuvw_1_1Utilities_1_1OS.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="util_8hpp_source.html">util.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a770ab48231aa27f3868516b0fdf3cacd"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a770ab48231aa27f3868516b0fdf3cacd">homedir</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a770ab48231aa27f3868516b0fdf3cacd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's home directory. <a href="#a770ab48231aa27f3868516b0fdf3cacd">More...</a><br /></td></tr>
|
|
<tr class="separator:a770ab48231aa27f3868516b0fdf3cacd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f7125f1eecdbedeea3322453114eeb8"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a8f7125f1eecdbedeea3322453114eeb8">tmpdir</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a8f7125f1eecdbedeea3322453114eeb8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the temp directory. <a href="#a8f7125f1eecdbedeea3322453114eeb8">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f7125f1eecdbedeea3322453114eeb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a973646ae5f6c0cd5b079bb8e201357f5"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a973646ae5f6c0cd5b079bb8e201357f5">env</a> (const std::string &name) noexcept</td></tr>
|
|
<tr class="memdesc:a973646ae5f6c0cd5b079bb8e201357f5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves an environment variable. <a href="#a973646ae5f6c0cd5b079bb8e201357f5">More...</a><br /></td></tr>
|
|
<tr class="separator:a973646ae5f6c0cd5b079bb8e201357f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e8d62c5b6dd954003e324b75c76e9a7"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a4e8d62c5b6dd954003e324b75c76e9a7">env</a> (const std::string &name, const std::string &value) noexcept</td></tr>
|
|
<tr class="memdesc:a4e8d62c5b6dd954003e324b75c76e9a7"><td class="mdescLeft"> </td><td class="mdescRight">Creates, updates or deletes an environment variable. <a href="#a4e8d62c5b6dd954003e324b75c76e9a7">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e8d62c5b6dd954003e324b75c76e9a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bdfdaceed79abba7c456e761702ce31"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a3bdfdaceed79abba7c456e761702ce31">hostname</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a3bdfdaceed79abba7c456e761702ce31"><td class="mdescLeft"> </td><td class="mdescRight">Returns the hostname. <a href="#a3bdfdaceed79abba7c456e761702ce31">More...</a><br /></td></tr>
|
|
<tr class="separator:a3bdfdaceed79abba7c456e761702ce31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d2504b52c450da8620741a835eae70b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structuvw_1_1Passwd.html">Passwd</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Utilities_1_1OS.html#a9d2504b52c450da8620741a835eae70b">passwd</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a9d2504b52c450da8620741a835eae70b"><td class="mdescLeft"> </td><td class="mdescRight">Gets a subset of the password file entry. <a href="#a9d2504b52c450da8620741a835eae70b">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d2504b52c450da8620741a835eae70b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="structuvw_1_1Utilities_1_1OS.html" title="OS dedicated utilities. ">OS</a> dedicated utilities. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00427">427</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a973646ae5f6c0cd5b079bb8e201357f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a973646ae5f6c0cd5b079bb8e201357f5">◆ </a></span>env() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string uvw::Utilities::OS::env </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves an environment variable. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the variable to be retrieved. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The value of the environment variable, an empty string in case of errors. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00461">461</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e8d62c5b6dd954003e324b75c76e9a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e8d62c5b6dd954003e324b75c76e9a7">◆ </a></span>env() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool uvw::Utilities::OS::env </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates, updates or deletes an environment variable. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the variable to be updated. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value to be used for the variable (an empty string to unset it). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00472">472</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a770ab48231aa27f3868516b0fdf3cacd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a770ab48231aa27f3868516b0fdf3cacd">◆ </a></span>homedir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string uvw::Utilities::OS::homedir </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's home directory. </p>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_homedir">documentation</a> for further details.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current user's home directory, an empty string in case of errors. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00438">438</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3bdfdaceed79abba7c456e761702ce31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bdfdaceed79abba7c456e761702ce31">◆ </a></span>hostname()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string uvw::Utilities::OS::hostname </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the hostname. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The hostname, an empty string in case of errors. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00480">480</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d2504b52c450da8620741a835eae70b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d2504b52c450da8620741a835eae70b">◆ </a></span>passwd()</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="structuvw_1_1Passwd.html">Passwd</a> uvw::Utilities::OS::passwd </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a subset of the password file entry. </p>
|
|
<p>This function can be used to get the subset of the password file entry for the current effective uid (not the real uid).</p>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_get_passwd">documentation</a> for further details.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The accessible subset of the password file entry. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00496">496</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f7125f1eecdbedeea3322453114eeb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f7125f1eecdbedeea3322453114eeb8">◆ </a></span>tmpdir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string uvw::Utilities::OS::tmpdir </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the temp directory. </p>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_tmpdir">documentation</a> for further details.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The temp directory, an empty string in case of errors. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00451">451</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="util_8hpp_source.html">util.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated 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>
|