original/man3/getpw.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 .\" Modified Sat Jul 24 19:23:25 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de)
  29 .\"
  30 .TH GETPW 3 2007-12-12 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 getpw \- Re-construct password line entry
  33 .SH SYNOPSIS
  34 .nf
  35 .B #define _GNU_SOURCE
  36 .B #include <sys/types.h>
  37 .B #include <pwd.h>
  38 .sp
  39 .BI "int getpw(uid_t " uid ", char *" buf );
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .BR getpw ()
  44 function reconstructs the password line entry for
  45 the given user ID \fIuid\fP in the buffer \fIbuf\fP.
  46 The returned buffer contains a line of format
  47 .sp
  48 .RS
  49 .B name:passwd:uid:gid:gecos:dir:shell
  50 .RE
  51 .PP
  52 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  53 .sp
  54 .in +4n
  55 .nf
  56 struct passwd {
  57     char   *pw_name;       /* username */
  58     char   *pw_passwd;     /* user password */
  59     uid_t   pw_uid;        /* user ID */
  60     gid_t   pw_gid;        /* group ID */
  61     char   *pw_gecos;      /* real name */
  62     char   *pw_dir;        /* home directory */
  63     char   *pw_shell;      /* shell program */
  64 };
  65 .fi
  66 .in
  67 .SH "RETURN VALUE"
  68 The
  69 .BR getpw ()
  70 function returns 0 on success; on error, it returns \-1, and
  71 .I errno
  72 is set to indicate the error.
  73 .SH ERRORS
  74 .TP
  75 .B EINVAL
  76 .I buf
  77 is NULL.
  78 .TP
  79 .B ENOENT
  80 No user corresponding to
  81 .IR uid .
  82 .TP
  83 .B ENOMEM
  84 Insufficient memory to allocate
  85 .I passwd
  86 structure.
  87 .SH FILES
  88 .TP
  89 .I /etc/passwd
  90 password database file
  91 .SH "CONFORMING TO"
  92 SVr2.
  93 .SH BUGS
  94 The
  95 .BR getpw ()
  96 function is dangerous as it may overflow the provided buffer
  97 .IR buf .
  98 It is obsoleted by
  99 .BR getpwuid (3).
 100 .SH "SEE ALSO"
 101 .BR endpwent (3),
 102 .BR fgetpwent (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)