man3/getpwent.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\"
  30 .\" Modified Sat Jul 24 19:22:14 1993 by Rik Faith (faith@cs.unc.edu)
  31 .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de)
  32 .\"
  33 .TH GETPWENT 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 getpwent, setpwent, endpwent \- get password file entry
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <sys/types.h>
  39 .B #include <pwd.h>
  40 .PP
  41 .B struct passwd *getpwent(void);
  42 .B void setpwent(void);
  43 .B void endpwent(void);
  44 .fi
  45 .PP
  46 .RS -4
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .RE
  50 .PP
  51 .BR getpwent (),
  52 .BR setpwent (),
  53 .BR endpwent ():
  54 .nf
  55     _XOPEN_SOURCE >= 500
  56 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  57         || /* Glibc since 2.19: */ _DEFAULT_SOURCE
  58         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  59 .fi
  60 .SH DESCRIPTION
  61 The
  62 .BR getpwent ()
  63 function returns a pointer to a structure containing
  64 the broken-out fields of a record from the password database
  65 (e.g., the local password file
  66 .IR /etc/passwd ,
  67 NIS, and LDAP).
  68 The first time
  69 .BR getpwent ()
  70 is called, it returns the first entry; thereafter, it returns successive
  71 entries.
  72 .PP
  73 The
  74 .BR setpwent ()
  75 function rewinds to the beginning
  76 of the password database.
  77 .PP
  78 The
  79 .BR endpwent ()
  80 function is used to close the password database
  81 after all processing has been performed.
  82 .PP
  83 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  84 .PP
  85 .in +4n
  86 .EX
  87 struct passwd {
  88     char   *pw_name;       /* username */
  89     char   *pw_passwd;     /* user password */
  90     uid_t   pw_uid;        /* user ID */
  91     gid_t   pw_gid;        /* group ID */
  92     char   *pw_gecos;      /* user information */
  93     char   *pw_dir;        /* home directory */
  94     char   *pw_shell;      /* shell program */
  95 };
  96 .EE
  97 .in
  98 .PP
  99 For more information about the fields of this structure, see
 100 .BR passwd (5).
 101 .SH RETURN VALUE
 102 The
 103 .BR getpwent ()
 104 function returns a pointer to a
 105 .I passwd
 106 structure, or NULL if
 107 there are no more entries or an error occurred.
 108 If an error occurs,
 109 .I errno
 110 is set to indicate the error.
 111 If one wants to check
 112 .I errno
 113 after the call, it should be set to zero before the call.
 114 .PP
 115 The return value may point to a static area, and may be overwritten
 116 by subsequent calls to
 117 .BR getpwent (),
 118 .BR getpwnam (3),
 119 or
 120 .BR getpwuid (3).
 121 (Do not pass the returned pointer to
 122 .BR free (3).)
 123 .SH ERRORS
 124 .TP
 125 .B EINTR
 126 A signal was caught; see
 127 .BR signal (7).
 128 .TP
 129 .B EIO
 130 I/O error.
 131 .TP
 132 .B EMFILE
 133 The per-process limit on the number of open file descriptors has been reached.
 134 .TP
 135 .B ENFILE
 136 The system-wide limit on the total number of open files has been reached.
 137 .TP
 138 .B ENOMEM
 139 .\" not in POSIX
 140 Insufficient memory to allocate
 141 .I passwd
 142 structure.
 143 .\" to allocate the passwd structure, or to allocate buffers
 144 .TP
 145 .B ERANGE
 146 Insufficient buffer space supplied.
 147 .SH FILES
 148 .TP
 149 .I /etc/passwd
 150 local password database file
 151 .SH ATTRIBUTES
 152 For an explanation of the terms used in this section, see
 153 .BR attributes (7).
 154 .ad l
 155 .nh
 156 .TS
 157 allbox;
 158 lb lb lbx
 159 l l l.
 160 Interface       Attribute       Value
 161 T{
 162 .BR getpwent ()
 163 T}      Thread safety   T{
 164 MT-Unsafe race:pwent
 165 race:pwentbuf locale
 166 T}
 167 T{
 168 .BR setpwent (),
 169 .BR endpwent ()
 170 T}      Thread safety   T{
 171 MT-Unsafe race:pwent locale
 172 T}
 173 .TE
 174 .hy
 175 .ad
 176 .sp 1
 177 In the above table,
 178 .I pwent
 179 in
 180 .I race:pwent
 181 signifies that if any of the functions
 182 .BR setpwent (),
 183 .BR getpwent (),
 184 or
 185 .BR endpwent ()
 186 are used in parallel in different threads of a program,
 187 then data races could occur.
 188 .SH CONFORMING TO
 189 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
 190 The
 191 .I pw_gecos
 192 field is not specified in POSIX, but is present on most implementations.
 193 .SH SEE ALSO
 194 .BR fgetpwent (3),
 195 .BR getpw (3),
 196 .BR getpwent_r (3),
 197 .BR getpwnam (3),
 198 .BR getpwuid (3),
 199 .BR putpwent (3),
 200 .BR passwd (5)