manual/LDP_man-pages/release/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 .SH 名前
  37 getgrent, setgrent, endgrent \- グループファイルエントリの取得
  38 .SH 書式
  39 .nf
  40 .B #include <sys/types.h>
  41 .B #include <grp.h>
  42 .sp
  43 .B struct group *getgrent(void);
  44 .sp
  45 .B void setgrent(void);
  46 .sp
  47 .B void endgrent(void);
  48 .fi
  49 .sp
  50 .in -4n
  51 glibc 向けの機能検査マクロの要件
  52 .RB ( feature_test_macros (7)
  53 参照):
  54 .in
  55 .sp
  56 .PD 0
  57 .ad l
  58 .BR setgrent ():
  59 .RS 4
  60 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  61 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED ||
  62 .br
  63 /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
  64 .RE
  65 .sp
  66 .BR getgrent (),
  67 .BR endgrent ():
  68 .RS 4
  69 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  70 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  71 .RE
  72 .PD
  73 .ad b
  74 .SH 説明
  75 .BR getgrent ()
  76 関数は、グループ・データベースから取得したエントリを
  77 要素毎に分解し、各要素を格納した構造体へのポインタを返す
  78 (グループ・データベースの例:
  79 ローカルのグループファイル
  80 .IR /etc/group ,
  81 NIS, LDAP)。
  82 .BR getgrent ()
  83 は、最初に呼び出された時は最初のエントリを返し、
  84 それ以降は呼び出される毎に次のエントリを返す。
  85 .PP
  86 .BR setgrent ()
  87 関数を使うと、もう一度読み込めるように、
  88 グループ・データベースの先頭に戻る。
  89 .PP
  90 .BR endgrent ()
  91 関数は、全ての処理が終わった後にグループ・
  92 データベースをクローズする。
  93 .PP
  94 \fIgroup\fP 構造体は、\fI<grp.h>\fP で以下のように定義されている:
  95 .sp
  96 .in +4n
  97 .nf
  98 struct group {
  99     char   *gr_name;       /* グループ名 */
 100     char   *gr_passwd;     /* グループのパスワード */
 101     gid_t   gr_gid;        /* グループ ID */
 102     char  **gr_mem;        /* グループのメンバ */
 103 };
 104 .fi
 105 .in
 106 .PP
 107 この構造体のフィールドの詳細は
 108 .BR group (5)
 109 を参照のこと。
 110 .SH 返り値
 111 .BR getgrent ()
 112 関数は
 113 .I group
 114 構造体へのポインタを返す。
 115 これ以上エントリが無いか、エラーが発生した場合は NULL を返す。
 116 .LP
 117 エラーが発生すると、
 118 .I errno
 119 が適切に設定される。
 120 この関数の呼び出し後に
 121 .I errno
 122 をチェックしたい場合は、呼び出し前に
 123 .I errno
 124 を 0 に設定しておかないといけない。
 125
 126 返り値は静的な領域を指しており、その後の
 127 .BR getgrent (),
 128 .BR getgrgid (3),
 129 .BR getgrnam (3)
 130 の呼び出しで上書きされるかもしれない。
 131 (返されたポインタを
 132 .BR free (3)
 133 に渡さないこと。)
 134 .SH エラー
 135 .TP
 136 .B EINTR
 137 シグナルがキャッチされた。
 138 .TP
 139 .B EIO
 140 I/O エラー。
 141 .TP
 142 .B EMFILE
 143 呼び出したプロセスが既にファイルをオープンし過ぎている。
 144 .TP
 145 .B ENFILE
 146 システム上にオープンされたファイルが多過ぎる。
 147 .TP
 148 .B ENOMEM
 149 .\" POSIX にはない。
 150 .I group
 151 構造体を割り当てるためのメモリが不十分。
 152 .TP
 153 .B ERANGE
 154 十分なバッファ空間がない。
 155 .SH ファイル
 156 .TP
 157 .I /etc/group
 158 ローカルのグループ・データベースファイル
 159 .SH 準拠
 160 SVr4, 4.3BSD, POSIX.1-2001.
 161 .SH 関連項目
 162 .BR fgetgrent (3),
 163 .BR getgrent_r (3),
 164 .BR getgrgid (3),
 165 .BR getgrnam (3)
 166 .BR getgrouplist (3),
 167 .BR putgrent (3),
 168 .BR group (5)