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  2009-03-30 "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 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE > = 500
  56 .ad b
  57 .SH DESCRIPTION
  58 The
  59 .BR getpwent ()
  60 function returns a pointer to a structure containing
  61 the broken-out fields of a record from the password database
  62 (e.g., the local password file
  63 .IR /etc/passwd ,
  64 NIS, and LDAP).
  65 The first time it
  66 is called it returns the first entry; thereafter, it returns successive
  67 entries.
  68 .PP
  69 The
  70 .BR setpwent ()
  71 function rewinds to the beginning
  72 of the password database.
  73 .PP
  74 The
  75 .BR endpwent ()
  76 function is used to close the password database
  77 after all processing has been performed.
  78 .PP
  79 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  80 .sp
  81 .in +4n
  82 .nf
  83 struct passwd {
  84     char   *pw_name;       /* username */
  85     char   *pw_passwd;     /* user password */
  86     uid_t   pw_uid;        /* user ID */
  87     gid_t   pw_gid;        /* group ID */
  88     char   *pw_gecos;      /* real name */
  89     char   *pw_dir;        /* home directory */
  90     char   *pw_shell;      /* shell program */
  91 };
  92 .fi
  93 .in
  94 .SH "RETURN VALUE"
  95 The
  96 .BR getpwent ()
  97 function returns a pointer to a
  98 .I passwd
  99 structure, or NULL if
 100 there are no more entries or an error occurs.
 101 If an error occurs,
 102 .I errno
 103 is set appropriately.
 104 If one wants to check
 105 .I errno
 106 after the call, it should be set to zero before the call.
 107
 108 The return value may point to a static area, and may be overwritten
 109 by subsequent calls to
 110 .BR getpwent (),
 111 .BR getpwnam (3),
 112 or
 113 .BR getpwuid (3).
 114 (Do not pass the returned pointer to
 115 .BR free (3).)
 116 .SH ERRORS
 117 .TP
 118 .B EINTR
 119 A signal was caught.
 120 .TP
 121 .B EIO
 122 I/O error.
 123 .TP
 124 .B EMFILE
 125 The maximum number
 126 .RB ( OPEN_MAX )
 127 of files was open already in the calling process.
 128 .TP
 129 .B ENFILE
 130 The maximum number of files was open already in the system.
 131 .TP
 132 .B ENOMEM
 133 .\" not in POSIX
 134 Insufficient memory to allocate
 135 .I passwd
 136 structure.
 137 .\" to allocate the passwd structure, or to allocate buffers
 138 .TP
 139 .B ERANGE
 140 Insufficient buffer space supplied.
 141 .SH FILES
 142 .TP
 143 .I /etc/passwd
 144 local password database file
 145 .SH "CONFORMING TO"
 146 SVr4, 4.3BSD, POSIX.1-2001.
 147 .SH "SEE ALSO"
 148 .BR fgetpwent (3),
 149 .BR getpw (3),
 150 .BR getpwent_r (3),
 151 .BR getpwnam (3),
 152 .BR getpwuid (3),
 153 .BR putpwent (3),
 154 .BR passwd (5)