opendir(3) [php man page]

OPENDIR(3)								 1								OPENDIR(3)

opendir - Open directory handle

SYNOPSIS

       resource opendir (string  $path, [resource  $context])

DESCRIPTION

	Opens up a directory handle to be used in subsequent closedir(3), readdir(3), and rewinddir(3) calls.

PARAMETERS

	      o $path
		- The directory path that is to be opened

	      o $context
		- For a description of the $context parameter, refer to the streams section of the manual.

RETURN VALUES

	Returns a directory handle resource on success, or FALSE on failure.

	If  $path  is  not  a  valid  directory or the directory can not be opened due to permission restrictions or filesystem errors, opendir(3)
       returns FALSE and generates a PHP error of level  E_WARNING. You can suppress the error output of opendir(3) by prepending '@' to the front
       of the function name.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.0.0	|						    |
       |	|						    |
       |	|      $path supports the ftp:// URL wrapper.	    |
       |	|						    |
       | 4.3.0	|						    |
       |	|						    |
       |	| $path  can  also be any URL which supports direc- |
       |	| tory listing, however only the file:// URL  wrap- |
       |	| per supports this in PHP 4			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      opendir(3) example

	      <?php
	      $dir = "/etc/php5/";

	      // Open a known directory, and proceed to read its contents
	      if (is_dir($dir)) {
		  if ($dh = opendir($dir)) {
		      while (($file = readdir($dh)) !== false) {
			  echo "filename: $file : filetype: " . filetype($dir . $file) . "
";
		      }
		      closedir($dh);
		  }
	      }
	      ?>

	      The above example will output something similar to:

	      filename: . : filetype: dir
	      filename: .. : filetype: dir
	      filename: apache : filetype: dir
	      filename: cgi : filetype: dir
	      filename: cli : filetype: dir

SEE ALSO

       is_dir(3), readdir(3), dir(3).

PHP Documentation Group 														OPENDIR(3)

DIRECTORY(3)						     Library Functions Manual						      DIRECTORY(3)

NAME

       opendir, readdir, telldir, seekdir, rewinddir, closedir - directory operations

SYNOPSIS

       #include <sys/types.h>
       #include <sys/dir.h>

       DIR *opendir(filename)
       char *filename;

       struct direct *readdir(dirp)
       DIR *dirp;

       long telldir(dirp)
       DIR *dirp;

       seekdir(dirp, loc)
       DIR *dirp;
       long loc;

       rewinddir(dirp)
       DIR *dirp;

       closedir(dirp)
       DIR *dirp;

DESCRIPTION

       Opendir	opens the directory named by filename and associates a directory stream with it.  Opendir returns a pointer to be used to identify
       the directory stream in subsequent operations.  The pointer NULL is returned if filename cannot be accessed,  or  if  it  cannot  malloc(3)
       enough memory to hold the whole thing.

       Readdir	returns  a  pointer  to  the next directory entry.  It returns NULL upon reaching the end of the directory or detecting an invalid
       seekdir operation.

       Telldir returns the current location associated with the named directory stream.

       Seekdir sets the position of the next readdir operation on the directory stream.  The new position reverts to the one associated  with  the
       directory  stream  when	the telldir operation was performed.  Values returned by telldir are good only for the lifetime of the DIR pointer
       from which they are derived.  If the directory is closed and then reopened, the telldir value may be invalidated due to	undetected  direc-
       tory compaction.  It is safe to use a previous telldir value immediately after a call to opendir and before any calls to readdir.

       Rewinddir resets the position of the named directory stream to the beginning of the directory.

       Closedir closes the named directory stream and frees the structure associated with the DIR pointer.

       Sample code which searchs a directory for entry ``name'' is:

	    len = strlen(name);
	    dirp = opendir(".");
	    for (dp = readdir(dirp); dp != NULL; dp = readdir(dirp))
		 if (dp->d_namlen == len && !strcmp(dp->d_name, name)) {
		      closedir(dirp);
		      return FOUND;
		 }
	    closedir(dirp);
	    return NOT_FOUND;

SEE ALSO

       open(2), close(2), read(2), lseek(2), dir(5)

4.2 Berkeley Distribution					September 24, 1985						      DIRECTORY(3)