NAME

rewinddir - reset the position of a directory stream to the beginning of a directory

SYNOPSIS

#include <dirent.h>

void rewinddir(DIR *dirp);


DESCRIPTION

The rewinddir() function shall reset the position of the directory stream to which dirp refers to the beginning of the directory. It shall also cause the directory stream to refer to the current state of the corresponding directory, as a call to opendir() would have done. If dirp does not refer to a directory stream, the effect is undefined.

After a call to the fork() function, either the parent or child (but not both) may continue processing the directory stream using readdir(), rewinddir(), or ^[XSI] seekdir(). If both the parent and child processes use these functions, the result is undefined.

RETURN VALUE

The rewinddir() function shall not return a value.

ERRORS

No errors are defined.

EXAMPLES

None.

APPLICATION USAGE

The rewinddir() function should be used in conjunction with opendir(), readdir(), and closedir() to examine the contents of the directory. This method is recommended for portability.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

closedir(), opendir(), readdir(), the Base Definitions volume of IEEE Std 1003.1-2001, <dirent.h> <sys/types.h>

CHANGE HISTORY

First released in Issue 2.

Issue 6

In the SYNOPSIS, the optional include of the <sys/types.h> header is removed.

The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:

• The requirement to include <sys/types.h> has been removed. Although <sys/types.h> was required for conforming implementations of previous POSIX specifications, it was not required for UNIX applications.