original/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  2013-06-21 "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 .sp
  41 .B struct passwd *getpwent(void);
  42 .sp
  43 .B void setpwent(void);
  44 .sp
  45 .B void endpwent(void);
  46 .fi
  47 .sp
  48 .in -4n
  49 Feature Test Macro Requirements for glibc (see
  50 .BR feature_test_macros (7)):
  51 .in
  52 .sp
  53 .ad l
  54 .BR getpwent (),
  55 .BR setpwent (),
  56 .BR endpwent ():
  57 .RS 4
  58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  59 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  60 .RE
  61 .ad b
  62 .SH DESCRIPTION
  63 The
  64 .BR getpwent ()
  65 function returns a pointer to a structure containing
  66 the broken-out fields of a record from the password database
  67 (e.g., the local password file
  68 .IR /etc/passwd ,
  69 NIS, and LDAP).
  70 The first time
  71 .BR getpwent ()
  72 is called, it returns the first entry; thereafter, it returns successive
  73 entries.
  74 .PP
  75 The
  76 .BR setpwent ()
  77 function rewinds to the beginning
  78 of the password database.
  79 .PP
  80 The
  81 .BR endpwent ()
  82 function is used to close the password database
  83 after all processing has been performed.
  84 .PP
  85 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  86 .sp
  87 .in +4n
  88 .nf
  89 struct passwd {
  90     char   *pw_name;       /* username */
  91     char   *pw_passwd;     /* user password */
  92     uid_t   pw_uid;        /* user ID */
  93     gid_t   pw_gid;        /* group ID */
  94     char   *pw_gecos;      /* user information */
  95     char   *pw_dir;        /* home directory */
  96     char   *pw_shell;      /* shell program */
  97 };
  98 .fi
  99 .in
 100 .PP
 101 For more information about the fields of this structure, see
 102 .BR passwd (5).
 103 .SH RETURN VALUE
 104 The
 105 .BR getpwent ()
 106 function returns a pointer to a
 107 .I passwd
 108 structure, or NULL if
 109 there are no more entries or an error occurs.
 110 If an error occurs,
 111 .I errno
 112 is set appropriately.
 113 If one wants to check
 114 .I errno
 115 after the call, it should be set to zero before the call.
 116
 117 The return value may point to a static area, and may be overwritten
 118 by subsequent calls to
 119 .BR getpwent (),
 120 .BR getpwnam (3),
 121 or
 122 .BR getpwuid (3).
 123 (Do not pass the returned pointer to
 124 .BR free (3).)
 125 .SH ERRORS
 126 .TP
 127 .B EINTR
 128 A signal was caught.
 129 .TP
 130 .B EIO
 131 I/O error.
 132 .TP
 133 .B EMFILE
 134 The maximum number
 135 .RB ( OPEN_MAX )
 136 of files was open already in the calling process.
 137 .TP
 138 .B ENFILE
 139 The maximum number of files was open already in the system.
 140 .TP
 141 .B ENOMEM
 142 .\" not in POSIX
 143 Insufficient memory to allocate
 144 .I passwd
 145 structure.
 146 .\" to allocate the passwd structure, or to allocate buffers
 147 .TP
 148 .B ERANGE
 149 Insufficient buffer space supplied.
 150 .SH FILES
 151 .TP
 152 .I /etc/passwd
 153 local password database file
 154 .SH ATTRIBUTES
 155 .SS Multithreading (see pthreads(7))
 156 The
 157 .BR getpwent ()
 158 function is not thread-safe.
 159 .LP
 160 The
 161 .BR setpwent ()
 162 and
 163 .BR endpwent ()
 164 functions are thread-safe.
 165 .SH CONFORMING TO
 166 SVr4, 4.3BSD, POSIX.1-2001.
 167 The
 168 .I pw_gecos
 169 field is not specified in POSIX, but is present on most implementations.
 170 .SH SEE ALSO
 171 .BR fgetpwent (3),
 172 .BR getpw (3),
 173 .BR getpwent_r (3),
 174 .BR getpwnam (3),
 175 .BR getpwuid (3),
 176 .BR putpwent (3),
 177 .BR passwd (5)
 178 .SH COLOPHON
 179 This page is part of release 3.65 of the Linux
 180 .I man-pages
 181 project.
 182 A description of the project,
 183 and information about reporting bugs,
 184 can be found at
 185 \%http://www.kernel.org/doc/man\-pages/.