setgrentのヘルプ・マニュアル
日本語 英語
setgrent --help
man setgrent
GETGRENT(3) Linux Programmer’s Manual GETGRENT(3)
名前
getgrent, setgrent, endgrent - グループファイルエントリの取得
書式
#include
#include
struct group *getgrent(void);
void setgrent(void);
void endgrent(void);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
getgrent(), setgrent(), endgrent(): _SVID_SOURCE || _BSD_SOURCE ||
_XOPEN_SOURCE >= 500
説明
getgrent() 関数は、グループ・データベースから取得したエントリを要素毎に
分 解し、各要素を格納した構造体へのポインタを返す (グループ・データベー
スの例: ローカルのグループファイル /etc/group, NIS, LDAP)。最初に呼び出
さ れた時は最初のエントリを返し、それ以降は呼び出される毎に次のエントリ
を返す。
setgrent() 関数を使うと、もう一度読み込めるように、グループ・データベー
スの先頭に戻る。
endgrent() 関数は、全ての処理が終わった後にグループ・データベースをクロ
ーズする。
group 構造体は、 で以下のように定義されている:
struct group {
char *gr_name; /* グループ名 */
char *gr_passwd; /* グループのパスワード */
gid_t gr_gid; /* グループ ID */
char **gr_mem; /* グループのメンバ */
};
返り値
getgrent() 関数は group 構造体へのポインタを返す。これ以上エントリが 無
いか、エラーが発生した場合は NULL を返す。
エ ラ ーが発生すると、 errno が適切に設定される。この関数の呼び出し後に
errno をチェックしたい場合は、呼び出し前に errno を 0 に設定しておか な
いといけない。
返 り値は静的な領域を指しており、その後の getgrent(), getgrgid(3), get-
grnam(3) の呼び出しで上書きされるかもしれない。 (返されたポ イ ン タ を
free(3) に渡さないこと。)
エラー
EINTR シグナルがキャッチされた。
EIO I/O エラー。
EMFILE 呼び出したプロセスが既にファイルをオープンし過ぎている。
ENFILE システム上にオープンされたファイルが多過ぎる。
ENOMEM group 構造体を割り当てるためのメモリが不十分。
ERANGE 十分なバッファ空間がない。
ファイル
/etc/group
ローカルのグループ・データベースファイル
準拠
SVr4, 4.3BSD, POSIX.1-2001.
関連項目
fgetgrent(3), getgrent_r(3), getgrgid(3), getgrnam(3) getgrouplist(3),
putgrent(3)
2009-03-30 GETGRENT(3)
GETGRENT(3) Linux Programmer’s Manual GETGRENT(3)
NAME
getgrent, setgrent, endgrent - get group file entry
SYNOPSIS
#include
#include
struct group *getgrent(void);
void setgrent(void);
void endgrent(void);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
getgrent(), setgrent(), endgrent(): _SVID_SOURCE || _BSD_SOURCE ||
_XOPEN_SOURCE >= 500
DESCRIPTION
The getgrent() function returns a pointer to a structure containing the
broken-out fields of a record in the group database (e.g., the local
group file /etc/group, NIS, and LDAP). The first time it is called it
returns the first entry; thereafter, it returns successive entries.
The setgrent() function rewinds to the beginning of the group database,
to allow repeated scans.
The endgrent() function is used to close the group database after all
processing has been performed.
The group structure is defined in as follows:
struct group {
char *gr_name; /* group name */
char *gr_passwd; /* group password */
gid_t gr_gid; /* group ID */
char **gr_mem; /* group members */
};
RETURN VALUE
The getgrent() function returns a pointer to a group structure, or NULL
if there are no more entries or an error occurs.
Upon error, errno may be set. If one wants to check errno after the
call, it should be set to zero before the call.
The return value may point to a static area, and may be overwritten by
subsequent calls to getgrent(), getgrgid(3), or getgrnam(3). (Do not
pass the returned pointer to free(3).)
ERRORS
EINTR A signal was caught.
EIO I/O error.
EMFILE The calling process already has too many open files.
ENFILE Too many open files in the system.
ENOMEM Insufficient memory to allocate group structure.
ERANGE Insufficient buffer space supplied.
FILES
/etc/group
local group database file
CONFORMING TO
SVr4, 4.3BSD, POSIX.1-2001.
SEE ALSO
fgetgrent(3), getgrent_r(3), getgrgid(3), getgrnam(3), getgrouplist(3),
putgrent(3)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
2009-03-30 GETGRENT(3)