311 lines
7.2 KiB
HTML
311 lines
7.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of GETPWENT</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>GETPWENT</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
getpwent, setpwent, endpwent - get password file entry
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/sys/types.h">sys/types.h</A>></B>
|
|
<B>#include <<A HREF="file:///usr/include/pwd.h">pwd.h</A>></B>
|
|
|
|
<B>struct passwd *getpwent(void);</B>
|
|
|
|
<B>void setpwent(void);</B>
|
|
|
|
<B>void endpwent(void);</B>
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
|
|
|
|
|
|
<P>
|
|
|
|
|
|
<B>getpwent</B>(),
|
|
|
|
<B>setpwent</B>(),
|
|
|
|
<B>endpwent</B>():
|
|
|
|
<DL COMPACT><DT id="1"><DD>
|
|
_XOPEN_SOURCE >= 500
|
|
|
|
<BR> || /* Glibc since 2.19: */ _DEFAULT_SOURCE
|
|
<BR> || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
|
|
</DL>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>getpwent</B>()
|
|
|
|
function returns a pointer to a structure containing
|
|
the broken-out fields of a record from the password database
|
|
(e.g., the local password file
|
|
<I>/etc/passwd</I>,
|
|
|
|
NIS, and LDAP).
|
|
The first time
|
|
<B>getpwent</B>()
|
|
|
|
is called, it returns the first entry; thereafter, it returns successive
|
|
entries.
|
|
<P>
|
|
|
|
The
|
|
<B>setpwent</B>()
|
|
|
|
function rewinds to the beginning
|
|
of the password database.
|
|
<P>
|
|
|
|
The
|
|
<B>endpwent</B>()
|
|
|
|
function is used to close the password database
|
|
after all processing has been performed.
|
|
<P>
|
|
|
|
The <I>passwd</I> structure is defined in <I><<A HREF="file:///usr/include/pwd.h">pwd.h</A>></I> as follows:
|
|
<P>
|
|
|
|
|
|
|
|
struct passwd {
|
|
<BR> char *pw_name; /* username */
|
|
<BR> char *pw_passwd; /* user password */
|
|
<BR> uid_t pw_uid; /* user ID */
|
|
<BR> gid_t pw_gid; /* group ID */
|
|
<BR> char *pw_gecos; /* user information */
|
|
<BR> char *pw_dir; /* home directory */
|
|
<BR> char *pw_shell; /* shell program */
|
|
};
|
|
|
|
|
|
|
|
<P>
|
|
|
|
When
|
|
<B><A HREF="/cgi-bin/man/man2html?5+shadow">shadow</A></B>(5)
|
|
|
|
passwords are enabled (which is default on many GNU/Linux
|
|
installations) the content of
|
|
<I>pw_passwd</I>
|
|
|
|
is usually not very useful. In such a case most passwords are stored
|
|
in a separate file.
|
|
<P>
|
|
|
|
The variable
|
|
<I>pw_shell</I>
|
|
|
|
may be empty, in which case the system will execute the default shell
|
|
(<B>/bin/sh</B>)
|
|
|
|
for the user.
|
|
<P>
|
|
|
|
For more information about the fields of this structure, see
|
|
<B><A HREF="/cgi-bin/man/man2html?5+passwd">passwd</A></B>(5).
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>getpwent</B>()
|
|
|
|
function returns a pointer to a
|
|
<I>passwd</I>
|
|
|
|
structure, or NULL if
|
|
there are no more entries or an error occurred.
|
|
If an error occurs,
|
|
<I>errno</I>
|
|
|
|
is set appropriately.
|
|
If one wants to check
|
|
<I>errno</I>
|
|
|
|
after the call, it should be set to zero before the call.
|
|
<P>
|
|
|
|
The return value may point to a static area, and may be overwritten
|
|
by subsequent calls to
|
|
<B>getpwent</B>(),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpwnam">getpwnam</A></B>(3),
|
|
|
|
or
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpwuid">getpwuid</A></B>(3).
|
|
|
|
(Do not pass the returned pointer to
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3).)
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="2"><B>EINTR</B>
|
|
|
|
<DD>
|
|
A signal was caught; see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+signal">signal</A></B>(7).
|
|
|
|
<DT id="3"><B>EIO</B>
|
|
|
|
<DD>
|
|
I/O error.
|
|
<DT id="4"><B>EMFILE</B>
|
|
|
|
<DD>
|
|
The per-process limit on the number of open file descriptors has been reached.
|
|
<DT id="5"><B>ENFILE</B>
|
|
|
|
<DD>
|
|
The system-wide limit on the total number of open files has been reached.
|
|
<DT id="6"><B>ENOMEM</B>
|
|
|
|
<DD>
|
|
|
|
Insufficient memory to allocate
|
|
<I>passwd</I>
|
|
|
|
structure.
|
|
|
|
<DT id="7"><B>ERANGE</B>
|
|
|
|
<DD>
|
|
Insufficient buffer space supplied.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="8"><I>/etc/passwd</I>
|
|
|
|
<DD>
|
|
local password database file
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>getpwent</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>
|
|
MT-Unsafe race:pwent
|
|
<BR>
|
|
|
|
race:pwentbuf locale
|
|
<BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>setpwent</B>(),
|
|
|
|
<BR>
|
|
|
|
<B>endpwent</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Unsafe race:pwent locale<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
In the above table,
|
|
<I>pwent</I>
|
|
|
|
in
|
|
<I>race:pwent</I>
|
|
|
|
signifies that if any of the functions
|
|
<B>setpwent</B>(),
|
|
|
|
<B>getpwent</B>(),
|
|
|
|
or
|
|
<B>endpwent</B>()
|
|
|
|
are used in parallel in different threads of a program,
|
|
then data races could occur.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
|
|
The
|
|
<I>pw_gecos</I>
|
|
|
|
field is not specified in POSIX, but is present on most implementations.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+fgetpwent">fgetpwent</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpw">getpw</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpwent_r">getpwent_r</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpwnam">getpwnam</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+getpwuid">getpwuid</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+putpwent">putpwent</A></B>(3),
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+shadow">shadow</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+passwd">passwd</A></B>(5)
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="12"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="13"><A HREF="#lbAF">ERRORS</A><DD>
|
|
<DT id="14"><A HREF="#lbAG">FILES</A><DD>
|
|
<DT id="15"><A HREF="#lbAH">ATTRIBUTES</A><DD>
|
|
<DT id="16"><A HREF="#lbAI">CONFORMING TO</A><DD>
|
|
<DT id="17"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="18"><A HREF="#lbAK">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:44 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|