explain_fdopendir_or_die(3) [debian man page]

explain_fdopendir_or_die(3)				     Library Functions Manual				       explain_fdopendir_or_die(3)

NAME

       explain_fdopendir_or_die - open a directory and report errors

SYNOPSIS

       #include <libexplain/fdopendir.h>
       DIR *explain_fdopendir_or_die(int fildes);
       DIR *explain_fdopendir_on_error(int fildes);

DESCRIPTION

       The  explain_fdopendir_or_die  function	is used to call the fdopendir(3) system call. On failure an explanation will be printed to stderr,
       obtained from the explain_fdopendir(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

       The explain_fdopendir_on_error function is used to call the fdopendir(3) system call. On failure an explanation will be printed to  stderr,
       obtained from the explain_fdopendir(3) function, but still returns to the caller.

       fildes  The fildes, exactly as to be passed to the fdopendir(3) system call.

RETURN VALUE

       The explain_fdopendir_or_die function only returns on success, see fdopendir(3) for more information. On failure, prints an explanation and
       exits, it does not return.

       The explain_fdopendir_on_error function always returns the value return by the wrapped fdopendir(3) system call.

EXAMPLE

       The explain_fdopendir_or_die function is intended to be used in a fashion similar to the following example:
	      DIR *result = explain_fdopendir_or_die(fildes);

SEE ALSO

       fdopendir(3)
	       open a directory

       explain_fdopendir(3)
	       explain fdopendir(3) errors

       exit(2) terminate the calling process

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2009 Peter Miller

														       explain_fdopendir_or_die(3)

opendir(3C)						   Standard C Library Functions 					       opendir(3C)

NAME

       opendir, fdopendir - open directory

SYNOPSIS

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

       DIR *opendir(const char *dirname);

       DIR *fdopendir(int fildes);

DESCRIPTION

       The opendir() function opens a directory stream corresponding to the directory named by the dirname argument.

       The  fdopendir()  function  opens  a directory stream for the directory file descriptor fildes. The directory file descriptor should not be
       used or closed following a successful function call, as this might cause undefined results from future operations on the  directory  stream
       obtained from the call. Use closedir(3C) to close a directory stream.

       The  directory  stream  is positioned at the first entry. If the type DIR is implemented using a file descriptor, applications will only be
       able to open up to a total of {OPEN_MAX} files and directories. A successful call to any of the exec functions  will  close  any  directory
       streams that are open in the calling process.  See exec(2).

RETURN VALUES

       Upon  successful completion, opendir() and fdopendir() return a pointer to an object of type DIR. Otherwise, a null pointer is returned and
       errno is set to indicate the error.

ERRORS

       The opendir() function will fail if:

       EACCES	       Search permission is denied for the component of the path prefix of dirname or read permission is denied for dirname.

       ELOOP	       Too many symbolic links were encountered in resolving path.

       ENAMETOOLONG    The length of the dirname argument  exceeds  {PATH_MAX},  or  a	path  name  component  is  longer  than  {NAME_MAX}  while
		       {_POSIX_NO_TRUNC} is in effect.

       ENOENT	       A component of dirname does not name an existing directory or dirname is an empty string.

       ENOTDIR	       A component of dirname is not a directory.

       The fdopendir() function will fail if:

       ENOTDIR	       The file descriptor fildes does not reference a directory.

       The opendir() function may fail if:

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

       ENAMETOOLONG    Pathname resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX.

       ENFILE	       Too many files are currently open on the system.

USAGE

       The  opendir() and fdopendir() functions should be used in conjunction with readdir(3C), closedir(3C) and rewinddir(3C) to examine the con-
       tents of the directory (see the EXAMPLES section in readdir(3C)). This method is recommended for portability.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |opendir()   is	Standard;  |
       |			     |fdopendir() is Evolving	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       lstat(2), symlink(2), closedir(3C), readdir(3C), rewinddir(3C), attributes(5)

SunOS 5.10							    1 Aug 2001							       opendir(3C)