uvw/structuvw_1_1Passwd.html
2017-10-11 09:11:53 +02:00

299 lines
14 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::Passwd 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
&#160;<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_1Passwd.html">Passwd</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structuvw_1_1Passwd-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::Passwd Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility class.
<a href="structuvw_1_1Passwd.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="util_8hpp_source.html">util.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a32fb64ac957376ca92248767db8bc9eb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#a32fb64ac957376ca92248767db8bc9eb">username</a> () const noexcept</td></tr>
<tr class="memdesc:a32fb64ac957376ca92248767db8bc9eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the username. <a href="#a32fb64ac957376ca92248767db8bc9eb">More...</a><br /></td></tr>
<tr class="separator:a32fb64ac957376ca92248767db8bc9eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e39fc936f1ccac26edd68c62a1646b2"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#a4e39fc936f1ccac26edd68c62a1646b2">uid</a> () const noexcept</td></tr>
<tr class="memdesc:a4e39fc936f1ccac26edd68c62a1646b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the uid. <a href="#a4e39fc936f1ccac26edd68c62a1646b2">More...</a><br /></td></tr>
<tr class="separator:a4e39fc936f1ccac26edd68c62a1646b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94792b4968ddcb4fe158aa8255406d79"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#a94792b4968ddcb4fe158aa8255406d79">gid</a> () const noexcept</td></tr>
<tr class="memdesc:a94792b4968ddcb4fe158aa8255406d79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the gid. <a href="#a94792b4968ddcb4fe158aa8255406d79">More...</a><br /></td></tr>
<tr class="separator:a94792b4968ddcb4fe158aa8255406d79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad817256d676d8de38eaa89ff6f8d5620"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#ad817256d676d8de38eaa89ff6f8d5620">shell</a> () const noexcept</td></tr>
<tr class="memdesc:ad817256d676d8de38eaa89ff6f8d5620"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the shell. <a href="#ad817256d676d8de38eaa89ff6f8d5620">More...</a><br /></td></tr>
<tr class="separator:ad817256d676d8de38eaa89ff6f8d5620"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1af30054a044b2d897dbcc517f54cfbe"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#a1af30054a044b2d897dbcc517f54cfbe">homedir</a> () const noexcept</td></tr>
<tr class="memdesc:a1af30054a044b2d897dbcc517f54cfbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the homedir. <a href="#a1af30054a044b2d897dbcc517f54cfbe">More...</a><br /></td></tr>
<tr class="separator:a1af30054a044b2d897dbcc517f54cfbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad42f80c7ea9259d8645683c05a3a14fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1Passwd.html#ad42f80c7ea9259d8645683c05a3a14fd">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:ad42f80c7ea9259d8645683c05a3a14fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the instance contains valid data. <a href="#ad42f80c7ea9259d8645683c05a3a14fd">More...</a><br /></td></tr>
<tr class="separator:ad42f80c7ea9259d8645683c05a3a14fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility class. </p>
<p>This class can be used to query the subset of the password file entry for the current effective uid (not the real uid).</p>
<dl class="section see"><dt>See also</dt><dd>Utilities::passwd </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00211">211</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="a94792b4968ddcb4fe158aa8255406d79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94792b4968ddcb4fe158aa8255406d79">&#9670;&nbsp;</a></span>gid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto uvw::Passwd::gid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the gid. </p>
<dl class="section return"><dt>Returns</dt><dd>The gid of the current effective uid (not the real uid). </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00234">234</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
</div>
</div>
<a id="a1af30054a044b2d897dbcc517f54cfbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1af30054a044b2d897dbcc517f54cfbe">&#9670;&nbsp;</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">std::string uvw::Passwd::homedir </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the homedir. </p>
<dl class="section return"><dt>Returns</dt><dd>The homedir of the current effective uid (not the real uid). </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00250">250</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
</div>
</div>
<a id="ad42f80c7ea9259d8645683c05a3a14fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad42f80c7ea9259d8645683c05a3a14fd">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uvw::Passwd::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the instance contains valid data. </p>
<dl class="section return"><dt>Returns</dt><dd>True if data are all valid, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00258">258</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
</div>
</div>
<a id="ad817256d676d8de38eaa89ff6f8d5620"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad817256d676d8de38eaa89ff6f8d5620">&#9670;&nbsp;</a></span>shell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string uvw::Passwd::shell </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the shell. </p>
<dl class="section return"><dt>Returns</dt><dd>The shell of the current effective uid (not the real uid). </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00242">242</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
</div>
</div>
<a id="a4e39fc936f1ccac26edd68c62a1646b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e39fc936f1ccac26edd68c62a1646b2">&#9670;&nbsp;</a></span>uid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto uvw::Passwd::uid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the uid. </p>
<dl class="section return"><dt>Returns</dt><dd>The current effective uid (not the real uid). </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00226">226</a> of file <a class="el" href="util_8hpp_source.html">util.hpp</a>.</p>
</div>
</div>
<a id="a32fb64ac957376ca92248767db8bc9eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32fb64ac957376ca92248767db8bc9eb">&#9670;&nbsp;</a></span>username()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string uvw::Passwd::username </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the username. </p>
<dl class="section return"><dt>Returns</dt><dd>The username of the current effective uid (not the real uid). </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_8hpp_source.html#l00218">218</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>