fgetpwent(3) — Linux manual page

fgetpwent(3)            Library Functions Manual            fgetpwent(3)

NAME

       fgetpwent - get password file entry

LIBRARY

       Standard C library (libc, -lc)

SYNOPSIS

       #include <stdio.h>
       #include <sys/types.h>
       #include <pwd.h>

       struct passwd *fgetpwent(FILE *stream);

   Feature Test Macro Requirements for glibc (see
   feature_test_macros(7)):

       fgetpwent():
           Since glibc 2.19:
               _DEFAULT_SOURCE
           glibc 2.19 and earlier:
               _SVID_SOURCE

DESCRIPTION

       The fgetpwent() function returns a pointer to a structure
       containing the broken out fields of a line in the file stream.
       The first time it is called it returns the first entry;
       thereafter, it returns successive entries.  The file referred to
       by stream must have the same format as /etc/passwd (see
       passwd(5)).

       The passwd structure is defined in <pwd.h> as follows:

           struct passwd {
               char   *pw_name;       /* username */
               char   *pw_passwd;     /* user password */
               uid_t   pw_uid;        /* user ID */
               gid_t   pw_gid;        /* group ID */
               char   *pw_gecos;      /* real name */
               char   *pw_dir;        /* home directory */
               char   *pw_shell;      /* shell program */
           };

RETURN VALUE

       The fgetpwent() function returns a pointer to a passwd structure,
       or NULL if there are no more entries or an error occurs.  In the
       event of an error, errno is set to indicate the error.

ERRORS

       ENOMEM Insufficient memory to allocate passwd structure.

FILES

       /etc/passwd
              password database file

ATTRIBUTES

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌────────────────────┬───────────────┬──────────────────────────┐
       │ Interface          │ Attribute     │ Value                    │
       ├────────────────────┼───────────────┼──────────────────────────┤
       │ fgetpwent()        │ Thread safety │ MT-Unsafe race:fgetpwent │
       └────────────────────┴───────────────┴──────────────────────────┘

STANDARDS

       None.

HISTORY

       SVr4.

SEE ALSO

       endpwent(3), fgetpwent_r(3), fopen(3), getpw(3), getpwent(3),
       getpwnam(3), getpwuid(3), putpwent(3), setpwent(3), passwd(5)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                   fgetpwent(3)

Pages that refer to this page: getpw(3), getpwent(3), getpwent_r(3), getpwnam(3), putpwent(3)

---