original/man3/fgetpwent.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:37:37 1993 by Rik Faith (faith@cs.unc.edu)
  29 .\" Modified Mon May 27 22:40:48 1996 by Martin Schulze (joey@linux.de)
  30 .\"
  31 .TH FGETPWENT 3  2008-07-10 "GNU" "Linux Programmer's Manual"
  32 .SH NAME
  33 fgetpwent \- get password file entry
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <stdio.h>
  37 .B #include <sys/types.h>
  38 .B #include <pwd.h>
  39 .sp
  40 .BI "struct passwd *fgetpwent(FILE *" stream );
  41 .fi
  42 .sp
  43 .in -4n
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .in
  47 .sp
  48 .BR fgetpwent ():
  49 _SVID_SOURCE
  50 .SH DESCRIPTION
  51 The
  52 .BR fgetpwent ()
  53 function returns a pointer to a structure containing
  54 the broken out fields of a line in the file \fIstream\fP.
  55 The first time it is called it returns the first entry;
  56 thereafter, it returns successive entries.
  57 The file referred to by
  58 .I stream
  59 must have the same format as
  60 .I /etc/passwd
  61 (see
  62 .BR passwd (5)).
  63 .PP
  64 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  65 .sp
  66 .in +4n
  67 .nf
  68 struct passwd {
  69     char   *pw_name;       /* username */
  70     char   *pw_passwd;     /* user password */
  71     uid_t   pw_uid;        /* user ID */
  72     gid_t   pw_gid;        /* group ID */
  73     char   *pw_gecos;      /* real name */
  74     char   *pw_dir;        /* home directory */
  75     char   *pw_shell;      /* shell program */
  76 };
  77 .fi
  78 .in
  79 .SH "RETURN VALUE"
  80 The
  81 .BR fgetpwent ()
  82 function returns a pointer to a
  83 .I passwd
  84 structure, or NULL if
  85 there are no more entries or an error occurs.
  86 .SH ERRORS
  87 .TP
  88 .B ENOMEM
  89 Insufficient memory to allocate
  90 .I passwd
  91 structure.
  92 .SH FILES
  93 .TP
  94 .I /etc/passwd
  95 password database file
  96 .SH "CONFORMING TO"
  97 SVr4.
  98 .SH "SEE ALSO"
  99 .BR endpwent (3),
 100 .BR fgetpwent_r (3),
 101 .BR fopen (3),
 102 .BR getpw (3),
 103 .BR getpwent (3),
 104 .BR getpwnam (3),
 105 .BR getpwuid (3),
 106 .BR putpwent (3),
 107 .BR setpwent (3),
 108 .BR passwd (5)