File: Password-Database-Functions.html

package info (click to toggle)
octave 10.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • 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: 660; xml: 192
file content (152 lines) | stat: -rw-r--r-- 7,058 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!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>Password Database Functions (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Password Database Functions (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Password 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="Group-Database-Functions.html" rel="next" title="Group Database Functions">
<link href="Current-Working-Directory.html" rel="prev" title="Current Working Directory">
<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="Password-Database-Functions">
<div class="nav-panel">
<p>
Next: <a href="Group-Database-Functions.html" accesskey="n" rel="next">Group Database Functions</a>, Previous: <a href="Current-Working-Directory.html" accesskey="p" rel="prev">Current Working Directory</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="Password-Database-Functions-1"><span>36.9 Password Database Functions<a class="copiable-link" href="#Password-Database-Functions-1"> &para;</a></span></h3>

<p>Octave&rsquo;s password 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">uid</code></dt>
<dd><p>The numeric user id.
</p>
</dd>
<dt><code class="code">gid</code></dt>
<dd><p>The numeric group id.
</p>
</dd>
<dt><code class="code">gecos</code></dt>
<dd><p>The GECOS field.
</p>
</dd>
<dt><code class="code">dir</code></dt>
<dd><p>The home directory.
</p>
</dd>
<dt><code class="code">shell</code></dt>
<dd><p>The initial shell.
</p></dd>
</dl>

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


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getpwent"><span><code class="def-type"><var class="var">pw_struct</var> =</code> <strong class="def-name">getpwent</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-getpwent"> &para;</a></span></dt>
<dd><p>Return a structure containing an entry from the password database,
opening it if necessary.
</p>
<p>Once the end of the data has been reached, <code class="code">getpwent</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFsetpwent">setpwent</a>, <a class="ref" href="#XREFendpwent">endpwent</a>.
</p></dd></dl>


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


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getpwuid"><span><code class="def-type"><var class="var">pw_struct</var> =</code> <strong class="def-name">getpwuid</strong> <code class="def-code-arguments">(<var class="var">uid</var>).</code><a class="copiable-link" href="#index-getpwuid"> &para;</a></span></dt>
<dd><p>Return a structure containing the first entry from the password database
with the user ID <var class="var">uid</var>.
</p>
<p>If the user ID does not exist in the database, <code class="code">getpwuid</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetpwnam">getpwnam</a>.
</p></dd></dl>


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


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getpwnam"><span><code class="def-type"><var class="var">pw_struct</var> =</code> <strong class="def-name">getpwnam</strong> <code class="def-code-arguments">(<var class="var">name</var>)</code><a class="copiable-link" href="#index-getpwnam"> &para;</a></span></dt>
<dd><p>Return a structure containing the first entry from the password database
with the user name <var class="var">name</var>.
</p>
<p>If the user name does not exist in the database, <code class="code">getpwname</code> returns 0.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetpwuid">getpwuid</a>.
</p></dd></dl>


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


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


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


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-endpwent"><span><code class="def-type">[<var class="var">status</var>, <var class="var">msg</var>] =</code> <strong class="def-name">endpwent</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-endpwent"> &para;</a></span></dt>
<dd><p>Close the password database.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgetpwent">getpwent</a>, <a class="ref" href="#XREFsetpwent">setpwent</a>.
</p></dd></dl>


</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Group-Database-Functions.html">Group Database Functions</a>, Previous: <a href="Current-Working-Directory.html">Current Working Directory</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>