getpwentのヘルプ・マニュアル
日本語 英語
getpwent --help
man getpwent
GETPWENT(3) Linux Programmer’s Manual GETPWENT(3)
名前
getpwent, setpwent, endpwent - パスワードファイルのエントリの取得
書式
#include
#include
struct passwd *getpwent(void);
void setpwent(void);
void endpwent(void);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
getpwent(), setpwent(), endpwent(): _BSD_SOURCE || _SVID_SOURCE ||
_XOPEN_SOURCE > = 500
説明
getpwent() 関数は、パスワード・データベースから取得したエントリを要素毎
に 分解し、各要素を格納した構造体へのポインタを返す (パスワード・データ
ベースの例: ローカルのパスワードファイル /etc/passwd, NIS, LDAP)。最 初
に 呼び出された時は最初のエントリを返し、それ以降は呼び出される毎に次の
エントリを返す。
setpwent() 関数を使うと、パスワード・データベースの先頭に戻る。
endpwent() 関数は、全ての処理が終わった後にパスワード・データベースをク
ローズする。
passwd 構造体は で以下のように定義されている:
struct passwd {
char *pw_passwd; /* ユーザのパスワード */
uid_t pw_uid; /* ユーザ ID */
gid_t pw_gid; /* グループ ID */
char *pw_gecos; /* 実名 */
char *pw_dir; /* ホームディレクトリ */
char *pw_shell; /* シェルプログラム */
};
返り値
getpwent() 関数は passwd 構造体へのポインタを返す。これ以上エントリが無
いか、エラーが発生した場合は NULL を返す。エラーが発生すると、 errno が
適切に設定される。この関数の呼び出し後に errno をチェックしたい場合は、
呼び出し前に errno を 0 に設定しておかないといけない。
返り値は静的な領域を指しており、その後の getpwent(), getpwnam(3), getp-
wuid(3) の 呼 び 出しで上書きされるかもしれない。 (返されたポインタを
free(3) に渡さないこと。)
エラー
EINTR シグナルが捕捉された。
EIO 入出力エラー。
EMFILE 呼び出し元プロセスがオープンされているファイル数がす で に 上 限
(OPEN_MAX) であった。
ENFILE システムでオープンされているファイル数がすでに上限であった。
ENOMEM passwd 構造体に割り当てるメモリが十分なかった。
ERANGE 十分なバッファ空間がない。
ファイル
/etc/passwd
ローカルのパスワード・データベースファイル
準拠
SVr4, 4.3BSD, POSIX.1-2001.
関連項目
fgetpwent(3), getpw(3), getpwent_r(3), getpwnam(3), getpwuid(3), putp-
went(3), passwd(5)
GNU 2009-03-30 GETPWENT(3)
GETPWENT(3) Linux Programmer’s Manual GETPWENT(3)
NAME
getpwent, setpwent, endpwent - get password file entry
SYNOPSIS
#include
#include
struct passwd *getpwent(void);
void setpwent(void);
void endpwent(void);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
getpwent(), setpwent(), endpwent(): _BSD_SOURCE || _SVID_SOURCE ||
_XOPEN_SOURCE > = 500
DESCRIPTION
The getpwent() function returns a pointer to a structure containing the
broken-out fields of a record from the password database (e.g., the
local password file /etc/passwd, NIS, and LDAP). The first time it is
called it returns the first entry; thereafter, it returns successive
entries.
The setpwent() function rewinds to the beginning of the password
database.
The endpwent() function is used to close the password database after
all processing has been performed.
The passwd structure is defined in as follows:
struct passwd {
char *pw_name; /* username */
char *pw_passwd; /* user password */
uid_t pw_uid; /* user ID */
gid_t pw_gid; /* group ID */
char *pw_gecos; /* real name */
char *pw_dir; /* home directory */
char *pw_shell; /* shell program */
};
RETURN VALUE
The getpwent() function returns a pointer to a passwd structure, or
NULL if there are no more entries or an error occurs. If an error
occurs, errno is set appropriately. 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 getpwent(), getpwnam(3), or getpwuid(3). (Do not
pass the returned pointer to free(3).)
ERRORS
EINTR A signal was caught.
EIO I/O error.
EMFILE The maximum number (OPEN_MAX) of files was open already in the
calling process.
ENFILE The maximum number of files was open already in the system.
ENOMEM Insufficient memory to allocate passwd structure.
ERANGE Insufficient buffer space supplied.
FILES
/etc/passwd
local password database file
CONFORMING TO
SVr4, 4.3BSD, POSIX.1-2001.
SEE ALSO
fgetpwent(3), getpw(3), getpwent_r(3), getpwnam(3), getpwuid(3), putp-
went(3), passwd(5)
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/.
GNU 2009-03-30 GETPWENT(3)