File: C:/Ruby27-x64/share/doc/ruby/html/Process/Sys.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Process::Sys - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-getegid">::getegid</a>
<li ><a href="#method-c-geteuid">::geteuid</a>
<li ><a href="#method-c-getgid">::getgid</a>
<li ><a href="#method-c-getuid">::getuid</a>
<li ><a href="#method-c-issetugid">::issetugid</a>
<li ><a href="#method-c-setegid">::setegid</a>
<li ><a href="#method-c-seteuid">::seteuid</a>
<li ><a href="#method-c-setgid">::setgid</a>
<li ><a href="#method-c-setregid">::setregid</a>
<li ><a href="#method-c-setresgid">::setresgid</a>
<li ><a href="#method-c-setresuid">::setresuid</a>
<li ><a href="#method-c-setreuid">::setreuid</a>
<li ><a href="#method-c-setrgid">::setrgid</a>
<li ><a href="#method-c-setruid">::setruid</a>
<li ><a href="#method-c-setuid">::setuid</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Process::Sys">
<h1 id="module-Process::Sys" class="module">
module Process::Sys
</h1>
<section class="description">
<p>The <a href="Sys.html"><code>Process::Sys</code></a> module contains <a href="UID.html"><code>UID</code></a> and <a href="GID.html"><code>GID</code></a> functions which provide direct bindings to the system calls of the same names instead of the more-portable versions of the same functionality found in the <a href="../Process.html"><code>Process</code></a>, <a href="UID.html"><code>Process::UID</code></a>, and <a href="GID.html"><code>Process::GID</code></a> modules.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-getegid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
egid → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::GID.eid → integer
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::Sys.geteid → integer
</span>
</div>
<div class="method-description">
<p>Returns the effective group ID for this process. Not available on all platforms.</p>
<pre class="ruby"><span class="ruby-constant">Process</span>.<span class="ruby-identifier">egid</span> <span class="ruby-comment">#=> 500</span>
</pre>
<div class="method-source-code" id="getegid-source">
<pre>static VALUE
proc_getegid(VALUE obj)
{
rb_gid_t egid = getegid();
return GIDT2NUM(egid);
}</pre>
</div>
</div>
</div>
<div id="method-c-geteuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
euid → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::UID.eid → integer
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::Sys.geteuid → integer
</span>
</div>
<div class="method-description">
<p>Returns the effective user ID for this process.</p>
<pre class="ruby"><span class="ruby-constant">Process</span>.<span class="ruby-identifier">euid</span> <span class="ruby-comment">#=> 501</span>
</pre>
<div class="method-source-code" id="geteuid-source">
<pre>static VALUE
proc_geteuid(VALUE obj)
{
rb_uid_t euid = geteuid();
return UIDT2NUM(euid);
}</pre>
</div>
</div>
</div>
<div id="method-c-getgid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
gid → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::GID.rid → integer
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::Sys.getgid → integer
</span>
</div>
<div class="method-description">
<p>Returns the (real) group ID for this process.</p>
<pre class="ruby"><span class="ruby-constant">Process</span>.<span class="ruby-identifier">gid</span> <span class="ruby-comment">#=> 500</span>
</pre>
<div class="method-source-code" id="getgid-source">
<pre>static VALUE
proc_getgid(VALUE obj)
{
rb_gid_t gid = getgid();
return GIDT2NUM(gid);
}</pre>
</div>
</div>
</div>
<div id="method-c-getuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
uid → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::UID.rid → integer
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
Process::Sys.getuid → integer
</span>
</div>
<div class="method-description">
<p>Returns the (real) user ID of this process.</p>
<pre class="ruby"><span class="ruby-constant">Process</span>.<span class="ruby-identifier">uid</span> <span class="ruby-comment">#=> 501</span>
</pre>
<div class="method-source-code" id="getuid-source">
<pre>static VALUE
proc_getuid(VALUE obj)
{
rb_uid_t uid = getuid();
return UIDT2NUM(uid);
}</pre>
</div>
</div>
</div>
<div id="method-c-issetugid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.issetugid → true or false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the process was created as a result of an execve(2) system call which had either of the setuid or setgid bits set (and extra privileges were given as a result) or if it has changed any of its real, effective or saved user or group IDs since it began execution.</p>
<div class="method-source-code" id="issetugid-source">
<pre>static VALUE
p_sys_issetugid(VALUE obj)
{
if (issetugid()) {
return Qtrue;
}
else {
return Qfalse;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-setegid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setegid(group) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the effective group ID of the calling process to <em>group</em>. Not available on all platforms.</p>
<div class="method-source-code" id="setegid-source">
<pre>static VALUE
p_sys_setegid(VALUE obj, VALUE id)
{
check_gid_switch();
if (setegid(OBJ2GID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-seteuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.seteuid(user) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the effective user ID of the calling process to <em>user</em>. Not available on all platforms.</p>
<div class="method-source-code" id="seteuid-source">
<pre>static VALUE
p_sys_seteuid(VALUE obj, VALUE id)
{
check_uid_switch();
if (seteuid(OBJ2UID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setgid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setgid(group) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the group ID of the current process to <em>group</em>. Not available on all platforms.</p>
<div class="method-source-code" id="setgid-source">
<pre>static VALUE
p_sys_setgid(VALUE obj, VALUE id)
{
check_gid_switch();
if (setgid(OBJ2GID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setregid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setregid(rid, eid) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the (group) real and/or effective group IDs of the current process to <em>rid</em> and <em>eid</em>, respectively. A value of <code>-1</code> for either means to leave that ID unchanged. Not available on all platforms.</p>
<div class="method-source-code" id="setregid-source">
<pre>static VALUE
p_sys_setregid(VALUE obj, VALUE rid, VALUE eid)
{
rb_gid_t rgid, egid;
check_gid_switch();
rgid = OBJ2GID(rid);
egid = OBJ2GID(eid);
if (setregid(rgid, egid) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setresgid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setresgid(rid, eid, sid) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the (group) real, effective, and saved user IDs of the current process to <em>rid</em>, <em>eid</em>, and <em>sid</em> respectively. A value of <code>-1</code> for any value means to leave that ID unchanged. Not available on all platforms.</p>
<div class="method-source-code" id="setresgid-source">
<pre>static VALUE
p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid)
{
rb_gid_t rgid, egid, sgid;
check_gid_switch();
rgid = OBJ2GID(rid);
egid = OBJ2GID(eid);
sgid = OBJ2GID(sid);
if (setresgid(rgid, egid, sgid) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setresuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setresuid(rid, eid, sid) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the (user) real, effective, and saved user IDs of the current process to <em>rid</em>, <em>eid</em>, and <em>sid</em> respectively. A value of <code>-1</code> for any value means to leave that ID unchanged. Not available on all platforms.</p>
<div class="method-source-code" id="setresuid-source">
<pre>static VALUE
p_sys_setresuid(VALUE obj, VALUE rid, VALUE eid, VALUE sid)
{
rb_uid_t ruid, euid, suid;
PREPARE_GETPWNAM;
check_uid_switch();
ruid = OBJ2UID1(rid);
euid = OBJ2UID1(eid);
suid = OBJ2UID1(sid);
FINISH_GETPWNAM;
if (setresuid(ruid, euid, suid) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setreuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setreuid(rid, eid) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the (user) real and/or effective user IDs of the current process to <em>rid</em> and <em>eid</em>, respectively. A value of <code>-1</code> for either means to leave that ID unchanged. Not available on all platforms.</p>
<div class="method-source-code" id="setreuid-source">
<pre>static VALUE
p_sys_setreuid(VALUE obj, VALUE rid, VALUE eid)
{
rb_uid_t ruid, euid;
PREPARE_GETPWNAM;
check_uid_switch();
ruid = OBJ2UID1(rid);
euid = OBJ2UID1(eid);
FINISH_GETPWNAM;
if (setreuid(ruid, euid) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setrgid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setrgid(group) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the real group ID of the calling process to <em>group</em>. Not available on all platforms.</p>
<div class="method-source-code" id="setrgid-source">
<pre>static VALUE
p_sys_setrgid(VALUE obj, VALUE id)
{
check_gid_switch();
if (setrgid(OBJ2GID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setruid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setruid(user) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the real user ID of the calling process to <em>user</em>. Not available on all platforms.</p>
<div class="method-source-code" id="setruid-source">
<pre>static VALUE
p_sys_setruid(VALUE obj, VALUE id)
{
check_uid_switch();
if (setruid(OBJ2UID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-setuid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
Process::Sys.setuid(user) → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the user ID of the current process to <em>user</em>. Not available on all platforms.</p>
<div class="method-source-code" id="setuid-source">
<pre>static VALUE
p_sys_setuid(VALUE obj, VALUE id)
{
check_uid_switch();
if (setuid(OBJ2UID(id)) != 0) rb_sys_fail(0);
return Qnil;
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>