draft/man3/getgrent.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:29:54 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\"
  29 .\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
  30 .\"     all rights reserved.
  31 .\" Translated 1997-12-19, HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
  32 .\" Updated & Modified 2004-05-30, Yuichi SATO <ysato444@yahoo.co.jp>
  33 .\" Updated & Modified 2005-09-06, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  34 .\"
  35 .TH GETGRENT 3  2010-10-21 "" "Linux Programmer's Manual"
  36 .\"O .SH NAME
  37 .SH Ì¾Á°
  38 .\"O getgrent, setgrent, endgrent \- get group file entry
  39 getgrent, setgrent, endgrent \- ¥°¥ë¡¼¥×¥Õ¥¡¥¤¥ë¥¨¥ó¥È¥ê¤Î¼èÆÀ
  40 .\"O .SH SYNOPSIS
  41 .SH ½ñ¼°
  42 .nf
  43 .B #include <sys/types.h>
  44 .B #include <grp.h>
  45 .sp
  46 .B struct group *getgrent(void);
  47 .sp
  48 .B void setgrent(void);
  49 .sp
  50 .B void endgrent(void);
  51 .fi
  52 .sp
  53 .in -4n
  54 .\"O Feature Test Macro Requirements for glibc (see
  55 .\"O .BR feature_test_macros (7)):
  56 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
  57 .RB ( feature_test_macros (7)
  58 »²¾È):
  59 .in
  60 .sp
  61 .PD 0
  62 .ad l
  63 .BR setgrent ():
  64 .RS 4
  65 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  66 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED ||
  67 .br
  68 /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
  69 .RE
  70 .sp
  71 .BR getgrent (),
  72 .BR endgrent ():
  73 .RS 4
  74 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  75 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  76 .RE
  77 .PD
  78 .ad b
  79 .\"O .SH DESCRIPTION
  80 .SH ÀâÌÀ
  81 .\"O The
  82 .\"O .BR getgrent ()
  83 .\"O function returns a pointer to a structure containing
  84 .\"O the broken-out fields of a record in the group database
  85 .\"O (e.g., the local group file
  86 .\"O .IR /etc/group ,
  87 .\"O NIS, and LDAP).
  88 .\"O The first time
  89 .\"O .BR getgrent ()
  90 .\"O is called,
  91 .\"O it returns the first entry; thereafter, it returns successive entries.
  92 .BR getgrent ()
  93 ´Ø¿ô¤Ï¡¢¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤«¤é¼èÆÀ¤·¤¿¥¨¥ó¥È¥ê¤ò
  94 Í×ÁÇËè¤ËÊ¬²ò¤·¡¢³ÆÍ×ÁÇ¤ò³ÊÇ¼¤·¤¿¹½Â¤ÂÎ¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹
  95 (¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤ÎÎã:
  96 ¥í¡¼¥«¥ë¤Î¥°¥ë¡¼¥×¥Õ¥¡¥¤¥ë
  97 .IR /etc/group ,
  98 NIS, LDAP)¡£
  99 .BR getgrent ()
 100 ¤Ï¡¢ºÇ½é¤Ë¸Æ¤Ó½Ð¤µ¤ì¤¿»þ¤ÏºÇ½é¤Î¥¨¥ó¥È¥ê¤òÊÖ¤·¡¢
 101 ¤½¤ì°Ê¹ß¤Ï¸Æ¤Ó½Ð¤µ¤ì¤ëËè¤Ë¼¡¤Î¥¨¥ó¥È¥ê¤òÊÖ¤¹¡£
 102 .PP
 103 .\"O The
 104 .\"O .BR setgrent ()
 105 .\"O function rewinds to the beginning
 106 .\"O of the group database, to allow repeated scans.
 107 .BR setgrent ()
 108 ´Ø¿ô¤ò»È¤¦¤È¡¢¤â¤¦°ìÅÙÆÉ¤ß¹þ¤á¤ë¤è¤¦¤Ë¡¢
 109 ¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤ÎÀèÆ¬¤ËÌá¤ë¡£
 110 .PP
 111 .\"O The
 112 .\"O .BR endgrent ()
 113 .\"O function is used to close the group database
 114 .\"O after all processing has been performed.
 115 .BR endgrent ()
 116 ´Ø¿ô¤Ï¡¢Á´¤Æ¤Î½èÍý¤¬½ª¤ï¤Ã¤¿¸å¤Ë¥°¥ë¡¼¥×¡¦
 117 ¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¥¯¥í¡¼¥º¤¹¤ë¡£
 118 .PP
 119 .\"O The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
 120 \fIgroup\fP ¹½Â¤ÂÎ¤Ï¡¢\fI<grp.h>\fP ¤Ç°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë:
 121 .sp
 122 .in +4n
 123 .nf
 124 struct group {
 125 .\"O     char   *gr_name;       /* group name */
 126 .\"O     char   *gr_passwd;     /* group password */
 127 .\"O     gid_t   gr_gid;        /* group ID */
 128 .\"O     char  **gr_mem;        /* group members */
 129     char   *gr_name;       /* ¥°¥ë¡¼¥×Ì¾ */
 130     char   *gr_passwd;     /* ¥°¥ë¡¼¥×¤Î¥Ñ¥¹¥ï¡¼¥É */
 131     gid_t   gr_gid;        /* ¥°¥ë¡¼¥× ID */
 132     char  **gr_mem;        /* ¥°¥ë¡¼¥×¤Î¥á¥ó¥Ð */
 133 };
 134 .fi
 135 .in
 136 .PP
 137 .\"O For more information about the fields of this structure, see
 138 .\"O .BR group (5).
 139 ¤³¤Î¹½Â¤ÂÎ¤Î¥Õ¥£¡¼¥ë¥É¤Î¾ÜºÙ¤Ï
 140 .BR group (5)
 141 ¤ò»²¾È¤Î¤³¤È¡£
 142 .\"O .SH "RETURN VALUE"
 143 .SH ÊÖ¤êÃÍ
 144 .\"O The
 145 .\"O .BR getgrent ()
 146 .\"O function returns a pointer to a
 147 .\"O .I group
 148 .\"O structure,
 149 .\"O or NULL if there are no more entries or an error occurs.
 150 .BR getgrent ()
 151 ´Ø¿ô¤Ï
 152 .I group
 153 ¹½Â¤ÂÎ¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£
 154 ¤³¤ì°Ê¾å¥¨¥ó¥È¥ê¤¬Ìµ¤¤¤«¡¢¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ï NULL ¤òÊÖ¤¹¡£
 155 .LP
 156 .\"O Upon error,
 157 .\"O .I errno
 158 .\"O may be set.
 159 .\"O If one wants to check
 160 .\"O .I errno
 161 .\"O after the call, it should be set to zero before the call.
 162 ¥¨¥é¡¼¤¬È¯À¸¤¹¤ë¤È¡¢
 163 .I errno
 164 ¤¬Å¬ÀÚ¤ËÀßÄê¤µ¤ì¤ë¡£
 165 ¤³¤Î´Ø¿ô¤Î¸Æ¤Ó½Ð¤·¸å¤Ë
 166 .I errno
 167 ¤ò¥Á¥§¥Ã¥¯¤·¤¿¤¤¾ì¹ç¤Ï¡¢¸Æ¤Ó½Ð¤·Á°¤Ë
 168 .I errno
 169 ¤ò 0 ¤ËÀßÄê¤·¤Æ¤ª¤«¤Ê¤¤¤È¤¤¤±¤Ê¤¤¡£
 170
 171 .\"O The return value may point to a static area, and may be overwritten
 172 .\"O by subsequent calls to
 173 .\"O .BR getgrent (),
 174 .\"O .BR getgrgid (3),
 175 .\"O or
 176 .\"O .BR getgrnam (3).
 177 .\"O (Do not pass the returned pointer to
 178 .\"O .BR free (3).)
 179 ÊÖ¤êÃÍ¤ÏÀÅÅª¤ÊÎÎ°è¤ò»Ø¤·¤Æ¤ª¤ê¡¢¤½¤Î¸å¤Î
 180 .BR getgrent (),
 181 .BR getgrgid (3),
 182 .BR getgrnam (3)
 183 ¤Î¸Æ¤Ó½Ð¤·¤Ç¾å½ñ¤¤µ¤ì¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
 184 (ÊÖ¤µ¤ì¤¿¥Ý¥¤¥ó¥¿¤ò
 185 .BR free (3)
 186 ¤ËÅÏ¤µ¤Ê¤¤¤³¤È¡£)
 187 .\"O .SH ERRORS
 188 .SH ¥¨¥é¡¼
 189 .TP
 190 .B EINTR
 191 .\"O A signal was caught.
 192 ¥·¥°¥Ê¥ë¤¬¥¥ã¥Ã¥Á¤µ¤ì¤¿¡£
 193 .TP
 194 .B EIO
 195 .\"O I/O error.
 196 I/O ¥¨¥é¡¼¡£
 197 .TP
 198 .B EMFILE
 199 .\"O The calling process already has too many open files.
 200 ¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤¬´û¤Ë¥Õ¥¡¥¤¥ë¤ò¥ª¡¼¥×¥ó¤·²á¤®¤Æ¤¤¤ë¡£
 201 .TP
 202 .B ENFILE
 203 .\"O Too many open files in the system.
 204 ¥·¥¹¥Æ¥à¾å¤Ë¥ª¡¼¥×¥ó¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤¬Â¿²á¤®¤ë¡£
 205 .TP
 206 .B ENOMEM
 207 .\"O .\" not in POSIX
 208 .\"O Insufficient memory to allocate
 209 .\"O .I group
 210 .\"O structure.
 211 .\" POSIX ¤Ë¤Ï¤Ê¤¤¡£
 212 .I group
 213 ¹½Â¤ÂÎ¤ò³ä¤êÅö¤Æ¤ë¤¿¤á¤Î¥á¥â¥ê¤¬ÉÔ½½Ê¬¡£
 214 .TP
 215 .B ERANGE
 216 .\"O Insufficient buffer space supplied.
 217 ½½Ê¬¤Ê¥Ð¥Ã¥Õ¥¡¶õ´Ö¤¬¤Ê¤¤¡£
 218 .SH ¥Õ¥¡¥¤¥ë
 219 .TP
 220 .I /etc/group
 221 .\"O local group database file
 222 ¥í¡¼¥«¥ë¤Î¥°¥ë¡¼¥×¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¥Õ¥¡¥¤¥ë
 223 .\"O .SH "CONFORMING TO"
 224 .SH ½àµò
 225 SVr4, 4.3BSD, POSIX.1-2001.
 226 .\"O .SH "SEE ALSO"
 227 .SH ´ØÏ¢¹àÌÜ
 228 .BR fgetgrent (3),
 229 .BR getgrent_r (3),
 230 .BR getgrgid (3),
 231 .BR getgrnam (3)
 232 .BR getgrouplist (3),
 233 .BR putgrent (3),
 234 .BR group (5)