diff options
| author | lukem <lukem@NetBSD.org> | 2005-04-19 04:38:04 +0000 |
|---|---|---|
| committer | lukem <lukem@NetBSD.org> | 2005-04-19 04:38:04 +0000 |
| commit | 2662d7cbb4abc817dbcd2a9956917f45fae969a9 (patch) | |
| tree | daf1dd2a6df0bc35ee62b571c757e8093b2302af /lib | |
| parent | 77c203997cf1f26dd18be1d5227192a80c3bb7f7 (diff) | |
Clarify getgr*_r() return value when entry isn't found.
Improve markup of various constants.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/libc/gen/getgrent.3 | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/lib/libc/gen/getgrent.3 b/lib/libc/gen/getgrent.3 index 8de9d0feaf1..c49327fc3fb 100644 --- a/lib/libc/gen/getgrent.3 +++ b/lib/libc/gen/getgrent.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: getgrent.3,v 1.24 2005/04/04 18:24:21 wiz Exp $ +.\" $NetBSD: getgrent.3,v 1.25 2005/04/19 04:38:04 lukem Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -29,7 +29,7 @@ .\" .\" @(#)getgrent.3 8.2 (Berkeley) 4/19/94 .\" -.Dd April 4, 2005 +.Dd April 19, 2005 .Dt GETGRENT 3 .Os .Sh NAME @@ -130,7 +130,8 @@ respectively, updating the contents of .Ar grp and storing a pointer to that in .Ar result , -and returning 0. +and returning +.Dv 0 . Storage used by .Ar grp is allocated from @@ -138,10 +139,18 @@ is allocated from which is .Ar buflen bytes in size. +If the requested entry cannot be found, +.Ar result +will point to +.Dv NULL +and +.Dv 0 +will be returned. If an error occurs, -an error number will be returned and +a non-zero error number will be returned and .Ar result -will point to null. +will point to +.Dv NULL . Calling .Fn getgrent_r from multiple threads will result in each thread reading a disjoint portion @@ -175,22 +184,19 @@ The functions .Fn getgrnam , and .Fn getgrent -return a pointer to the group entry if successful; if end-of-file -is reached or an error occurs a null pointer is returned. +return a valid pointer to a group structure on success +and a +.Dv NULL +pointer if the entry was not found or an error occurs. .Pp The functions .Fn getgrgid_r , .Fn getgrnam_r , and .Fn getgrent_r -return 0 if sucessful and update -.Ar result -to point to -.Ar grp . -If an error occurs -an error code is returned and -.Ar result -will contain a null pointer. +return +.Dv 0 +on success or entry not found and non-zero on failure. .Pp The .Fn setgroupent |
