getpwent(3) - Linux man page

Name

getpwent, setpwent, endpwent - get password file entry

Synopsis

#include <sys/types.h>#include <pwd.h>
struct passwd *getpwent(void);
void setpwent(void);
void endpwent(void);

Description

The getpwent() function returns a pointer to a structure containing the broken-out fields of a record from the password database (e.g., the local password file /etc/passwd, NIS, and LDAP). The first time it is called it returns the first entry; thereafter, it returns successive entries.

The setpwent() function rewinds to the beginning of the password database.

The endpwent() function is used to close the password database after all processing has been performed.

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

struct passwd {
    char   *pw_name;       /* user name */
    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 getpwent() function returns a pointer to a passwd structure, or NULL if there are no more entries or an error occurs. If an error occurs, errno is set appropriately. If one wants to check errno after the call, it should be set to zero before the call.

Errors

EINTR
A signal was caught.
EIO
I/O error.
EMFILE
The maximum number (OPEN_MAX) of files was open already in the calling process.
ENFILE
The maximum number of files was open already in the system.
ENOMEM
Insufficient memory to allocate passwd structure.
ERANGE
Insufficient buffer space supplied.

Files

/etc/passwd
local password database file

Conforming to

SVr4, 4.3BSD, POSIX.1-2001.

See Also

fgetpwent(3), getpw(3), getpwent_r(3), getpwnam(3), getpwuid(3), putpwent(3), passwd(5)

Referenced By

fgetpwent_r(3), gentoo(1), hlfsd(8), nss(5), nsswitch.conf(5), saslauthd(8), setaliasent(3), shadow(3), winbindd(8), xscreensaver(1)