glibc/pwd/pwd.h

/* Copyright (C) 1991, 1992, 1995, 1996 Free Software Foundation, Inc.
This file is part of the GNU C Library.

The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Library General Public License for more details.

You should have received a copy of the GNU Library General Public
License along with the GNU C Library; see the file COPYING.LIB.  If
not, write to the Free Software Foundation, Inc., 675 Mass Ave,
Cambridge, MA 02139, USA.  */

/*
 *	POSIX Standard: 9.2.2 User Database Access	<pwd.h>
 */

#ifndef	_PWD_H

#define	_PWD_H	1
#include <features.h>

__BEGIN_DECLS

#include <gnu/types.h>


/* The passwd structure.  */
struct passwd
{
  char *pw_name;		/* Username.  */
  char *pw_passwd;		/* 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.  */
};


#if defined(__USE_SVID) || defined(__USE_GNU)
#define	__need_FILE
#include <stdio.h>
#endif

#ifdef	__USE_GNU
/* Return a new stream open on the password file.  */
extern FILE *__pwdopen __P ((void));

/* Read a password entry from STREAM, filling in P.
   Return the `struct passwd' of P if successful, NULL on failure.  */
extern struct passwd *__pwdread __P ((FILE * __stream, __ptr_t __p));

/* Return a chunk of memory containing pre-initialized data for __pwdread.  */
extern __ptr_t __pwdalloc __P ((void));

/* Scan the password file, filling in P, until SELECTOR returns nonzero for
   an entry.  Return the `struct passwd' of P if successful, NULL on
   failure.  */
extern struct passwd *__pwdscan __P ((__ptr_t *__p,
				      int (*__selector) (struct passwd *)));
#endif


#if defined(__USE_SVID) || defined(__USE_MISC)
/* Rewind the password-file stream.  */
extern void setpwent __P ((void));

/* Close the password-file stream.  */
extern void endpwent __P ((void));

/* Read an entry from the password-file stream, opening it if necessary.  */
extern struct passwd *getpwent __P ((void));
#endif

#ifdef	__USE_SVID
/* Read an entry from STREAM.  */
extern struct passwd *fgetpwent __P ((FILE * __stream));

/* Write the given entry onto the given stream.  */
extern int putpwent __P ((__const struct passwd * __p, FILE * __f));
#endif

/* Search for an entry with a matching user ID.  */
extern struct passwd *getpwuid __P ((__uid_t __uid));

/* Search for an entry with a matching username.  */
extern struct passwd *getpwnam __P ((__const char *__name));

#ifdef	__USE_REENTRANT
/* Reasonable value for the buffer sized used in the reentrant
   functions below.  But better use `sysconf'.  */
#define	NSS_BUFLEN_PASSWD	1024

/* Reentrant versions of some of the functions above.

   PLEASE NOTE: these functions are not yet standardized.  The interface
   may change in later versions of this library.  */

#if defined(__USE_SVID) || defined(__USE_MISC)
extern struct passwd *__getpwent_r __P ((struct passwd *__resultbuf,
					 char *__buffer, int __buflen));
extern struct passwd *getpwent_r __P ((struct passwd *__resultbuf,
				       char *__buffer, int __buflen));
#endif

extern struct passwd *__getpwuid_r __P ((__uid_t __uid,
					 struct passwd *__resultbuf,
					 char *__buffer, int __buflen));
extern struct passwd *getpwuid_r __P ((__uid_t __uid,
				       struct passwd *__resultbuf,
				       char *__buffer, int __buflen));

extern struct passwd *__getpwnam_r __P ((__const char *__name,
					 struct passwd *__resultbuf,
					 char *__buffer, int __buflen));
extern struct passwd *getpwnam_r __P ((__const char *__name,
				       struct passwd *__resultbuf,
				       char *__buffer, int __buflen));


#ifdef	__USE_SVID
/* Read an entry from STREAM.  */
extern struct passwd *__fgetpwent_r __P ((FILE * __stream,
					  struct passwd *__resultbuf,
					  char *__buffer, int __buflen));
extern struct passwd *fgetpwent_r __P ((FILE * __stream,
					struct passwd *__resultbuf,
					char *__buffer, int __buflen));
#endif

#endif	/* reentrant */


__END_DECLS

#endif /* pwd.h  */