OSDN Git Service

6722d9fd2754c13cfafe825d0b381fa9695fde37
[linuxjm/LDP_man-pages.git] / draft / man3 / fgetpwent.3
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
6 .\"
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
11 .\"
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein.  The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
18 .\" professionally.
19 .\"
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
22 .\"
23 .\" References consulted:
24 .\"     Linux libc source code
25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26 .\"     386BSD man pages
27 .\"
28 .\" Modified Sat Jul 24 19:37:37 1993 by Rik Faith (faith@cs.unc.edu)
29 .\" Modified Mon May 27 22:40:48 1996 by Martin Schulze (joey@linux.de)
30 .\"
31 .\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
32 .\"     all rights reserved.
33 .\" Translated 1997-12-18, HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
34 .\" Updated 2008-08-01, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
35 .\"
36 .TH FGETPWENT 3  2008-07-10 "GNU" "Linux Programmer's Manual"
37 .\"O .SH NAME
38 .SH 名前
39 .\"O fgetpwent \- get password file entry
40 fgetpwent \- パスワードファイルエントリの取り出し
41 .\"O .SH SYNOPSIS
42 .SH 書式
43 .nf
44 .B #include <stdio.h>
45 .B #include <sys/types.h>
46 .B #include <pwd.h>
47 .sp
48 .BI "struct passwd *fgetpwent(FILE *" stream );
49 .fi
50 .sp
51 .in -4n
52 .\"O Feature Test Macro Requirements for glibc (see
53 .\"O .BR feature_test_macros (7)):
54 glibc 向けの機能検査マクロの要件
55 .RB ( feature_test_macros (7)
56 参照):
57 .in
58 .sp
59 .BR fgetpwent ():
60 _SVID_SOURCE
61 .\"O .SH DESCRIPTION
62 .SH 説明
63 .\"O The
64 .\"O .BR fgetpwent ()
65 .\"O function returns a pointer to a structure containing
66 .\"O the broken out fields of a line in the file \fIstream\fP.
67 .\"O The first time it is called it returns the first entry;
68 .\"O thereafter, it returns successive entries.
69 .\"O The file referred to by
70 .\"O .I stream
71 .\"O must have the same format as
72 .\"O .I /etc/passwd
73 .\"O (see
74 .\"O .BR passwd (5)).
75 .BR fgetpwent ()
76 関数は、\fIstream\fP から得られた行を分解したフィールド
77 を含む構造体へのポインタを返す。
78 最初に呼び出された時には最初のエントリを返し、それ以降は
79 次のエントリを返す。
80 .I stream
81 で参照されるファイルは
82 .I /etc/passwd
83 と同じ形式でなければならない
84 .RB ( passwd (5)
85 参照)。
86 .PP
87 .\"O The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
88 \fIpasswd\fP 構造体は、\fI<pwd.h>\fP で以下のように定義されている:
89 .sp
90 .nf
91 .in +4n
92 struct passwd {
93 .\"O     char   *pw_name;       /* username */
94 .\"O     char   *pw_passwd;     /* user password */
95 .\"O     uid_t   pw_uid;        /* user ID */
96 .\"O     gid_t   pw_gid;        /* group ID */
97 .\"O     char   *pw_gecos;      /* real name */
98 .\"O     char   *pw_dir;        /* home directory */
99 .\"O     char   *pw_shell;      /* shell program */
100     char   *pw_name;       /* ユーザ名 */
101     char   *pw_passwd;     /* ユーザのパスワード */
102     uid_t   pw_uid;        /* ユーザ ID */
103     gid_t   pw_gid;        /* グループ ID */
104     char   *pw_gecos;      /* 本名 */
105     char   *pw_dir;        /* ホームディレクトリ */
106     char   *pw_shell;      /* シェルプログラム */
107 };
108 .fi
109 .in
110 .\"O .SH "RETURN VALUE"
111 .SH 返り値
112 .\"O The
113 .\"O .BR fgetpwent ()
114 .\"O function returns a pointer to a
115 .\"O .I passwd
116 .\"O structure, or NULL if
117 .\"O there are no more entries or an error occurs.
118 .BR fgetpwent ()
119 関数は、
120 .I passwd
121 構造体へのポインタを返す。
122 これ以上エントリが無いか、エラーが発生した場合は NULL を返す。
123 .\"O .SH ERRORS
124 .SH エラー
125 .TP
126 .B ENOMEM
127 .\"O Insufficient memory to allocate
128 .\"O .I passwd
129 .\"O structure.
130 .I passwd
131 構造体を割り当てるためのメモリが不十分。
132 .\"O .SH FILES
133 .SH ファイル
134 .TP
135 .I /etc/passwd
136 .\"O password database file
137 パスワードデータベースファイル
138 .\"O .SH "CONFORMING TO"
139 .SH 準拠
140 SVr4.
141 .\"O .SH "SEE ALSO"
142 .SH 関連項目
143 .BR endpwent (3),
144 .BR fgetpwent_r (3),
145 .BR fopen (3),
146 .BR getpw (3),
147 .BR getpwent (3),
148 .BR getpwnam (3),
149 .BR getpwuid (3),
150 .BR putpwent (3),
151 .BR setpwent (3),
152 .BR passwd (5)