original/man3/getpwent.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\"
  28 .\" Modified Sat Jul 24 19:22:14 1993 by Rik Faith (faith@cs.unc.edu)
  29 .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de)
  30 .\"
  31 .TH GETPWENT 3  2010-10-21 "GNU" "Linux Programmer's Manual"
  32 .SH NAME
  33 getpwent, setpwent, endpwent \- get password file entry
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <sys/types.h>
  37 .B #include <pwd.h>
  38 .sp
  39 .B struct passwd *getpwent(void);
  40 .sp
  41 .B void setpwent(void);
  42 .sp
  43 .B void endpwent(void);
  44 .fi
  45 .sp
  46 .in -4n
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .in
  50 .sp
  51 .ad l
  52 .BR getpwent (),
  53 .BR setpwent (),
  54 .BR endpwent ():
  55 .RS 4
  56 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  57 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  58 .RE
  59 .ad b
  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 .sp
  85 .in +4n
  86 .nf
  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 .fi
  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 occurs.
 108 If an error occurs,
 109 .I errno
 110 is set appropriately.
 111 If one wants to check
 112 .I errno
 113 after the call, it should be set to zero before the call.
 114
 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.
 127 .TP
 128 .B EIO
 129 I/O error.
 130 .TP
 131 .B EMFILE
 132 The maximum number
 133 .RB ( OPEN_MAX )
 134 of files was open already in the calling process.
 135 .TP
 136 .B ENFILE
 137 The maximum number of files was open already in the system.
 138 .TP
 139 .B ENOMEM
 140 .\" not in POSIX
 141 Insufficient memory to allocate
 142 .I passwd
 143 structure.
 144 .\" to allocate the passwd structure, or to allocate buffers
 145 .TP
 146 .B ERANGE
 147 Insufficient buffer space supplied.
 148 .SH FILES
 149 .TP
 150 .I /etc/passwd
 151 local password database file
 152 .SH "CONFORMING TO"
 153 SVr4, 4.3BSD, POSIX.1-2001.
 154 The
 155 .I pw_gecos
 156 field is not specified in POSIX, but is present on most implementations.
 157 .SH "SEE ALSO"
 158 .BR fgetpwent (3),
 159 .BR getpw (3),
 160 .BR getpwent_r (3),
 161 .BR getpwnam (3),
 162 .BR getpwuid (3),
 163 .BR putpwent (3),
 164 .BR passwd (5)