endgrent (original) (raw)

The Open Group Base Specifications Issue 6
IEEE Std 1003.1, 2004 Edition
Copyright © 2001-2004 The IEEE and The Open Group, All Rights reserved.

A newer edition of this document exists here

NAME

endgrent, getgrent, setgrent - group database entry functions

SYNOPSIS

`[XSI] #include <grp.h>

void endgrent(void);
struct group *getgrent(void);
void setgrent(void);

`

DESCRIPTION

The getgrent() function shall return a pointer to a structure containing the broken-out fields of an entry in the group database. When first called, getgrent() shall return a pointer to a group structure containing the first entry in the group database. Thereafter, it shall return a pointer to a group structure containing the next group structure in the group database, so successive calls may be used to search the entire database.

An implementation that provides extended security controls may impose further implementation-defined restrictions on accessing the group database. In particular, the system may deny the existence of some or all of the group database entries associated with groups other than those groups associated with the caller and may omit users other than the caller from the list of members of groups in database entries that are returned.

The setgrent() function shall rewind the group database to allow repeated searches.

The endgrent() function may be called to close the group database when processing is complete.

These functions need not be reentrant. A function that is not required to be reentrant is not required to be thread-safe.

RETURN VALUE

When first called, getgrent() shall return a pointer to the first group structure in the group database. Upon subsequent calls it shall return the next group structure in the group database. The getgrent() function shall return a null pointer on end-of-file or an error and errno may be set to indicate the error.

The return value may point to a static area which is overwritten by a subsequent call to getgrgid(), getgrnam(), or_getgrent_().

ERRORS

The getgrent() function may fail if:

[EINTR]

A signal was caught during the operation.

[EIO]

An I/O error has occurred.

[EMFILE]

{OPEN_MAX} file descriptors are currently open in the calling process.

[ENFILE]

The maximum allowable number of files is currently open in the system.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

These functions are provided due to their historical usage. Applications should avoid dependencies on fields in the group database, whether the database is a single file, or where in the file system name space the database resides. Applications should use getgrnam() and getgrgid()whenever possible because it avoids these dependencies.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

getgrgid(), getgrnam(), getlogin(), getpwent(), the Base Definitions volume of IEEE Std 1003.1-2001, <grp.h>

CHANGE HISTORY

First released in Issue 4, Version 2.

Issue 5

Moved from X/OPEN UNIX extension to BASE.

Normative text previously in the APPLICATION USAGE section is moved to the RETURN VALUE section.

A note indicating that these functions need not be reentrant is added to the DESCRIPTION.

Issue 6

In the DESCRIPTION, the note about reentrancy is expanded to cover thread-safety.

End of informative text.

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
[ Main Index | XBD | XCU | XSH | XRAT]