getgrent

名前

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

書式

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

struct group *getgrent(void);

void setgrent(void);

void endgrent(void);

setgrent(): getgrent(), endgrent():

説明

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

シグナルが捕捉された。signal(7) 参照。

EIO

I/O エラー。

EMFILE

オープンされたファイルディスクリプター数がプロセス毎の上限に達している。

ENFILE

オープンされたファイルの総数がシステム全体の上限に達している。

ENOENT

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

ENOMEM

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

ERANGE

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

ファイル

/etc/group

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

属性

この節で使用されている用語の説明については、 attributes(7) を参照。

インターフェース	属性	値
getgrent()	Thread safety	MT-Unsafe race:grent race:grentbuf locale
setgrent(), endgrent()	Thread safety	MT-Unsafe race:grent locale

In the above table, grent in race:grent signifies that if any of the functions setgrent(), getgrent(), or endgrent() are used in parallel in different threads of a program, then data races could occur.

準拠

POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.

関連項目

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

この文書について

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