File: Group-Database-Functions.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (139 lines) | stat: -rw-r--r-- 6,704 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Group Database Functions (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Group Database Functions (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Group Database Functions (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="System-Utilities.html" rel="up" title="System Utilities">
<link href="System-Information.html" rel="next" title="System Information">
<link href="Password-Database-Functions.html" rel="prev" title="Password Database Functions">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="section-level-extent" id="Group-Database-Functions">
<div class="nav-panel">
<p>
Next: <a href="System-Information.html" accesskey="n" rel="next">System Information</a>, Previous: <a href="Password-Database-Functions.html" accesskey="p" rel="prev">Password Database Functions</a>, Up: <a href="System-Utilities.html" accesskey="u" rel="up">System Utilities</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Group-Database-Functions-1"><span>36.10 Group Database Functions<a class="copiable-link" href="#Group-Database-Functions-1"> &para;</a></span></h3>

<p>Octave&rsquo;s group database functions return information in a structure
with the following fields.
</p>
<dl class="table">
<dt><code class="code">name</code></dt>
<dd><p>The user name.
</p>
</dd>
<dt><code class="code">passwd</code></dt>
<dd><p>The encrypted password, if available.
</p>
</dd>
<dt><code class="code">gid</code></dt>
<dd><p>The numeric group id.
</p>
</dd>
<dt><code class="code">mem</code></dt>
<dd><p>The members of the group.
</p></dd>
</dl>

<p>In the descriptions of the following functions, this data structure is
referred to as a <var class="var">grp_struct</var>.
</p>
<a class="anchor" id="XREFgetgrent"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getgrent"><span><code class="def-type"><var class="var">grp_struct</var> =</code> <strong class="def-name">getgrent</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-getgrent"> &para;</a></span></dt>
<dd><p>Return an entry from the group database, opening it if necessary.
</p>
<p>Once the end of data has been reached, <code class="code">getgrent</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFsetgrent">setgrent</a>, <a class="ref" href="#XREFendgrent">endgrent</a>.
</p></dd></dl>


<a class="anchor" id="XREFgetgrgid"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getgrgid"><span><code class="def-type"><var class="var">grp_struct</var> =</code> <strong class="def-name">getgrgid</strong> <code class="def-code-arguments">(<var class="var">gid</var>).</code><a class="copiable-link" href="#index-getgrgid"> &para;</a></span></dt>
<dd><p>Return the first entry from the group database with the group ID
<var class="var">gid</var>.
</p>
<p>If the group ID does not exist in the database, <code class="code">getgrgid</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetgrnam">getgrnam</a>.
</p></dd></dl>


<a class="anchor" id="XREFgetgrnam"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getgrnam"><span><code class="def-type"><var class="var">grp_struct</var> =</code> <strong class="def-name">getgrnam</strong> <code class="def-code-arguments">(<var class="var">name</var>)</code><a class="copiable-link" href="#index-getgrnam"> &para;</a></span></dt>
<dd><p>Return the first entry from the group database with the group name
<var class="var">name</var>.
</p>
<p>If the group name does not exist in the database, <code class="code">getgrnam</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetgrgid">getgrgid</a>.
</p></dd></dl>


<a class="anchor" id="XREFsetgrent"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-setgrent"><span><code class="def-type">[<var class="var">status</var>, <var class="var">msg</var>] =</code> <strong class="def-name">setgrent</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-setgrent"> &para;</a></span></dt>
<dd><p>Return the internal pointer to the beginning of the group database.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetgrent">getgrent</a>, <a class="ref" href="#XREFendgrent">endgrent</a>.
</p></dd></dl>


<a class="anchor" id="XREFendgrent"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-endgrent"><span><code class="def-type">[<var class="var">status</var>, <var class="var">msg</var>] =</code> <strong class="def-name">endgrent</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-endgrent"> &para;</a></span></dt>
<dd><p>Close the group database.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetgrent">getgrent</a>, <a class="ref" href="#XREFsetgrent">setgrent</a>.
</p></dd></dl>


</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="System-Information.html">System Information</a>, Previous: <a href="Password-Database-Functions.html">Password Database Functions</a>, Up: <a href="System-Utilities.html">System Utilities</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>