getpwent_r - ライブラリコールの説明 - Linux コマンド集 一覧表
名前
getpwent_r, fgetpwent_r - パスワードファイルのエントリをリエントラント (reentrant) に取り出す
書式
"#define _GNU_SOURCE"
#include <pwd.h>
int getpwent_r(struct passwd *pwbuf, char *buf,
size_t buflen, struct passwd **pwbufp);
int fgetpwent_r(FILE *fp, struct passwd *pwbuf, char *buf,
size_t buflen, struct passwd **pwbufp);
説明
関数 getpwent_r()と fgetpwent_r()は getpwent(3) と fgetpwent(3) のリエントラント版である。 前者は、 setpwent(3)によって初期化されたストリームから、次のパスワードエントリを読み込む。 後者は、引き数 fpとして与えられたストリームから、次のパスワードエントリを読み込む。
passwd 構造体は
<pwd.h>において以下のように定義されている:
struct passwd { char *pw_name; /* ユーザ名 */ char *pw_passwd; /* ユーザのパスワード */ uid_t pw_uid; /* ユーザ ID */ gid_t pw_gid; /* グループ ID */ char *pw_gecos; /* 実際の名前 */ char *pw_dir; /* ホームディレクトリ */ char *pw_shell; /* シェルプログラム */ };
リエントラントでない関数は静的な格納領域へのポインタを返す。 この静的な格納領域には、更にユーザ名・パスワード・gecos フィールド・ ホームディレクトリ・シェルへのポインタが含まれる。 ここで説明されているリエントラントな関数は、 呼び出し側から提供されるバッファにユーザ名など全てを返す。 最初の引き数として struct passwd を保持できるバッファ pwbuf がある。 次にその他の文字列を保持できるサイズ buflen のバッファ buf がある。 これらの関数の結果 (ストリームから読み込まれた struct passwd) は、 提供されたバッファ * pwbuf に格納され、この struct passwd へのポインタは * pwbufp に返される。
返り値
成功した場合、これらの関数は 0 を返し、 * pwbufp は struct passwd へのポインタとなる。 エラーの場合、これらの関数はエラー値を返し、 * pwbufp は NULL になる。
エラー
- ENOENT
- 次のエントリがない。
- ERANGE
- 十分なバッファ空間が与えられていない。 もっと大きなバッファで再度実行すること。
例
#define _GNU_SOURCE #include <pwd.h> #include <stdio.h> #define BUFLEN 4096
int main() { struct passwd pw, *pwp; char buf[BUFLEN]; int i;
setpwent(); while (1) { i = getpwent_r(&pw, buf, BUFLEN, &pwp); if (i) break; printf("%s (%d)\tHOME %s\tSHELL %s\n", pwp->pw_name, pwp->pw_uid, pwp->pw_dir, pwp->pw_shell); } endpwent(); return 0; }
準拠
これらの関数は GNU 拡張であり、POSIX 版の関数
getpwnam_r
(3)の形式に似せてある。
他のシステムではプロトタイプ
struct passwd * getpwent_r(struct passwd *pwd, char *buf, int buflen);
が使われている。 より良いものでは、
int getpwent_r(struct passwd *pwd, char *buf, int buflen, FILE **pw_fp);
が使われている。
注意
関数 getpwent_r ()は本当のリエントラントではない。 なぜなら、ストリームの読み込み位置を 他の全てのスレッドと共有しているためである。
関連項目
fgetpwent
(3),
getpw
(3),
getpwent
(3),
getpwnam
(3),
getpwuid
(3),
putpwent
(3),
passwd
(5)