名前

       getgrent, setgrent, endgrent - グループファイルエントリーの取得

書式

       #include <sys/types.h>
       #include <grp.h>

       struct group *getgrent(void);

       void setgrent(void);

       void endgrent(void);

   glibc 向けの機能検査マクロの要件 (feature_test_macros(7)  参照):

       setgrent():
           _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED ||
           /* Since glibc 2.12: */ _POSIX_C_SOURCE >= 200809L

       getgrent(), endgrent():
           _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED

説明

       getgrent()  関数は、グループデータベースから取得したエントリーを 要素毎に分解し、各要素を格納した構造体へ
       のポインターを返す   (グループデータベースの例:   ローカルのグループファイル   /etc/group,  NIS,  LDAP)。
       getgrent() は、最初に呼び出された時は最初のエントリーを返し、  それ以降は呼び出される毎に次のエントリーを
       返す。

       setgrent()  関数を使うと、もう一度読み込めるように、 グループデータベースの先頭に戻る。

       endgrent()  関数は、全ての処理が終わった後にグループ データベースをクローズする。

       group 構造体は <grp.h> で以下のように定義されている:

           struct group {
               char   *gr_name;        /* グループ名 */
               char   *gr_passwd;      /* グループのパスワード */
               gid_t   gr_gid;         /* グループ ID */
               char  **gr_mem;         /* グループのメンバ名へのポインター
                                          の配列 (配列はヌルで終端する) */
           };

       この構造体のフィールドの詳細は group(5)  を参照のこと。

返り値

       getgrent()   関数は group 構造体へのポインターを返す。 これ以上エントリーが無いか、エラーが発生した場合は
       NULL を返す。

       エラーが発生すると、 errno が適切に設定される。 この関数の呼び出し後に errno をチェックしたい場合は、呼び
       出し前に errno を 0 に設定しておかないといけない。

       返り値は静的な領域を指しており、その後の getgrent(), getgrgid(3), getgrnam(3)  の呼び出しで上書きされるか
       もしれない。 (返されたポインターを free(3)  に渡さないこと。)

エラー

       EAGAIN サービスが一時的に利用できなかったこと。あとでもう一度試してほしい。 NSS バックエンドの場合、glibc
              では、バックエンドとの通信中に一時的なエラーが発生したことを示す。  このエラーは直るかもしれないの
              で、あとでもう一度試すよう提案している。

       EINTR  シグナルが捕捉された。

       EIO    I/O エラー。

       EMFILE 呼び出したプロセスが既にファイルをオープンし過ぎている。

       ENFILE システム上にオープンされたファイルが多過ぎる。

       ENOENT 必要な入力ファイルが見つからなかった。 NSS バックエンドの場合、glibc  では、このエラーはバックエン
              ドが正しく設定されていないことを示す。

       ENOMEM group 構造体を割り当てるためのメモリーが不十分。

       ERANGE 与えられたバッファー空間が不十分である。

ファイル

       /etc/group
              ローカルのグループデータベースファイル

属性

   マルチスレッディング (pthreads(7) 参照)
       getgrent() 関数はスレッドセーフではない。

       関数 setgrent() と endgrent() はスレッドセーフである。

準拠

       SVr4, 4.3BSD, POSIX.1-2001.

関連項目

       fgetgrent(3), getgrent_r(3), getgrgid(3), getgrnam(3) getgrouplist(3), putgrent(3), group(5)

この文書について

       この man ページは Linux man-pages プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告
       に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。

                                                   2014-10-02                                        GETGRENT(3)