Mac Developer Library Developer
Search

 

This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.




GETFSSTAT(2)                BSD System Calls Manual               GETFSSTAT(2)

NAME
     getfsstat -- get list of all mounted file systems

SYNOPSIS
     #include <sys/param.h>
     #include <sys/ucred.h>
     #include <sys/mount.h>

     int
     getfsstat(struct statfs *buf, int bufsize, int flags);

TRANSITIIONAL SYNOPSIS (NOW DEPRECATED)
     int
     getfsstat64(struct statfs64 *buf, int bufsize, int flags);

DESCRIPTION
     The getfsstat() function returns information about all mounted file systems.  The buf argument is a
     pointer to an array of statfs structures (see statfs(2)).  As statfs(2) indicates, the structure is
     defined differently depending on whether the macro _DARWIN_FEATURE_64_BIT_INODE is defined (see stat(2)
     for more information on this macro).

     Fields that are undefined for a particular file system are set to -1.  The buffer is filled with an
     array of statfs structures, one for each mounted file system up to the size specified by bufsize.

     If buf is given as NULL, getfsstat() returns just the number of mounted file systems.

     If flags is set to MNT_NOWAIT, getfsstat() will directly return the information retained in the kernel
     to avoid delays caused by waiting for updated information from a file system that is perhaps temporar-ily temporarily
     ily unable to respond.  Some of the information returned may be out of date, however; if flags is set
     to MNT_WAIT or MNT_DWAIT instead, getfsstat() will request updated information from each mounted
     filesystem before returning.

RETURN VALUES
     Upon successful completion, the number of statfs structures is returned.  Otherwise, -1 is returned and
     the global variable errno is set to indicate the error.

ERRORS
     Getfsstat() fails if one or more of the following are true:

     [EFAULT]           The buf argument points to an invalid address.

     [EIO]              An I/O error occurred while reading from or writing to the file system.

TRANSITIONAL DESCRIPTION (NOW DEPRECATED)
     The getfsstat64() routine is equivalent to the default getfstat() (when _DARWIN_FEATURE_64_BIT_INODE is
     defined), so there is no longer any reason to use it (it will be removed in the future).

SEE ALSO
     stat(2), statfs(2), fstab(5), mount(8)

HISTORY
     The getfsstat() function first appeared in 4.4BSD.

BSD                              Oct 28, 2008                              BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback