File: Group-Database-Functions.html

package info (click to toggle)
octave 7.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 130,464 kB
  • sloc: cpp: 332,823; ansic: 71,320; fortran: 20,963; objc: 8,562; sh: 8,115; yacc: 4,882; lex: 4,438; perl: 1,554; java: 1,366; awk: 1,257; makefile: 652; xml: 173
file content (131 lines) | stat: -rw-r--r-- 5,612 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, 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 7.3.0))</title>

<meta name="description" content="Group Database Functions (GNU Octave (version 7.3.0))">
<meta name="keywords" content="Group Database Functions (GNU Octave (version 7.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-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="section" id="Group-Database-Functions">
<div class="header">
<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>
<span id="Group-Database-Functions-1"></span><h3 class="section">36.10 Group Database Functions</h3>

<p>Octave&rsquo;s group database functions return information in a structure
with the following fields.
</p>
<dl compact="compact">
<dt><span><code>name</code></span></dt>
<dd><p>The user name.
</p>
</dd>
<dt><span><code>passwd</code></span></dt>
<dd><p>The encrypted password, if available.
</p>
</dd>
<dt><span><code>gid</code></span></dt>
<dd><p>The numeric group id.
</p>
</dd>
<dt><span><code>mem</code></span></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>grp_struct</var>.
</p>
<span id="XREFgetgrent"></span><dl class="def">
<dt id="index-getgrent"><span class="category">: </span><span><em><var>grp_struct</var> =</em> <strong>getgrent</strong> <em>()</em><a href='#index-getgrent' class='copiable-anchor'> &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>getgrent</code> returns 0.
</p>
<p><strong>See also:</strong> <a href="#XREFsetgrent">setgrent</a>, <a href="#XREFendgrent">endgrent</a>.
</p></dd></dl>


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


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


<span id="XREFsetgrent"></span><dl class="def">
<dt id="index-setgrent"><span class="category">: </span><span><em></em> <strong>setgrent</strong> <em>()</em><a href='#index-setgrent' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Return the internal pointer to the beginning of the group database.
</p>
<p><strong>See also:</strong> <a href="#XREFgetgrent">getgrent</a>, <a href="#XREFendgrent">endgrent</a>.
</p></dd></dl>


<span id="XREFendgrent"></span><dl class="def">
<dt id="index-endgrent"><span class="category">: </span><span><em></em> <strong>endgrent</strong> <em>()</em><a href='#index-endgrent' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Close the group database.
</p>
<p><strong>See also:</strong> <a href="#XREFgetgrent">getgrent</a>, <a href="#XREFsetgrent">setgrent</a>.
</p></dd></dl>


</div>



</body>
</html>