grp/grp.h

   1 /* Copyright (C) 1991, 1992, 1995, 1996 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 /*
  20  *      POSIX Standard: 9.2.1 Group Database Access     <grp.h>
  21  */
  22
  23 #ifndef _GRP_H
  24
  25 #define _GRP_H  1
  26 #include <features.h>
  27
  28 __BEGIN_DECLS
  29
  30 #include <gnu/types.h>
  31
  32 #define __need_size_t
  33 #include <stddef.h>
  34
  35 #define __need_size_t
  36 #include <stddef.h>
  37
  38
  39 /* The group structure.  */
  40 struct group
  41   {
  42     char *gr_name;              /* Group name.  */
  43     char *gr_passwd;            /* Password.    */
  44     __gid_t gr_gid;             /* Group ID.    */
  45     char **gr_mem;              /* Member list. */
  46   };
  47
  48
  49 #if defined(__USE_SVID) || defined(__USE_GNU)
  50 #define __need_FILE
  51 #include <stdio.h>
  52 #endif
  53
  54 #ifdef  __USE_GNU
  55 /* Return a new stream open on the group file.  */
  56 extern FILE *__grpopen __P ((void));
  57
  58 /* Read a group entry from STREAM, filling in G.
  59    Return the `struct group' of G if successful, NULL on failure.  */
  60 extern struct group *__grpread __P ((FILE *__stream, __ptr_t __g));
  61
  62 /* Return a chunk of memory containing pre-initialized data for __grpread.  */
  63 extern __ptr_t __grpalloc __P ((void));
  64
  65 /* Scan the group file, filling in G, until SELECTOR returns nonzero for an
  66    entry.  Return the `struct group' of G if successful, NULL on failure.  */
  67 extern struct group *__grpscan __P ((__ptr_t *__p,
  68                                      int (*__selector) (struct group *)));
  69 #endif
  70
  71
  72 #if defined(__USE_SVID) || defined (__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
  73 /* Rewind the group-file stream.  */
  74 extern void setgrent __P ((void));
  75
  76 /* Close the group-file stream.  */
  77 extern void endgrent __P ((void));
  78
  79 /* Read an entry from the group-file stream, opening it if necessary.  */
  80 extern struct group *getgrent __P ((void));
  81 #endif
  82
  83 #ifdef  __USE_SVID
  84 /* Read a group entry from STREAM.  */
  85 extern struct group *fgetgrent __P ((FILE *__stream));
  86 #endif
  87
  88 /* Search for an entry with a matching group ID.  */
  89 extern struct group *getgrgid __P ((__gid_t __gid));
  90
  91 /* Search for an entry with a matching group name.  */
  92 extern struct group *getgrnam __P ((__const char *__name));
  93
  94 #ifdef  __USE_REENTRANT
  95 /* Reasonable value for the buffer sized used in the reentrant
  96    functions below.  But better use `sysconf'.  */
  97 #define NSS_BUFLEN_GROUP        1024
  98
  99 /* Reentrant versions of some of the functions above.
 100
 101    PLEASE NOTE: these functions are not yet standardized.  The interface
 102    may change in later versions of this library.  */
 103
 104 #if defined(__USE_SVID) || defined (__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
 105 extern int getgrent_r __P ((struct group *__resultbuf, char *buffer,
 106                             size_t __buflen, struct group **__result));
 107 #endif
 108
 109 /* Search for an entry with a matching group ID.  */
 110 extern int getgrgid_r __P ((__gid_t __gid, struct group *__resultbuf,
 111                             char *buffer, size_t __buflen,
 112                             struct group **__result));
 113
 114 /* Search for an entry with a matching group name.  */
 115 extern int getgrnam_r __P ((__const char *__name, struct group *__resultbuf,
 116                             char *buffer, size_t __buflen,
 117                             struct group **__result));
 118
 119 #ifdef  __USE_SVID
 120 /* Read a group entry from STREAM.  */
 121 extern int __fgetgrent_r __P ((FILE * __stream, struct group *__resultbuf,
 122                                char *buffer, size_t __buflen,
 123                                struct group **__result));
 124 extern int fgetgrent_r __P ((FILE * __stream, struct group *__resultbuf,
 125                              char *buffer, size_t __buflen,
 126                              struct group **__result));
 127 #endif
 128
 129 #endif  /* reentrant */
 130
 131
 132 #ifdef  __USE_BSD
 133
 134 #define __need_size_t
 135 #include <stddef.h>
 136
 137 /* Set the group set for the current user to GROUPS (N of them).  */
 138 extern int setgroups __P ((size_t __n, __const __gid_t *__groups));
 139
 140 /* Initialize the group set for the current user
 141    by reading the group database and using all groups
 142    of which USER is a member.  Also include GROUP.  */
 143 extern int initgroups __P ((__const char *__user, __gid_t __group));
 144
 145 #endif /* Use BSD.  */
 146
 147 __END_DECLS
 148
 149 #endif /* grp.h  */