Documentation Archive Developer
Search
ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



GETMNTINFO(3)            BSD Library Functions Manual            GETMNTINFO(3)

NAME
     getmntinfo -- get information about mounted file systems

LIBRARY
     Standard C Library (libc, -lc)

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

     int
     getmntinfo(struct statfs **mntbufp, int flags);

     int
     getmntinfo64(struct statfs64 **mntbufp, int flags);

DESCRIPTION
     The getmntinfo() function returns an array of statfs structures describ-ing describing
     ing each currently mounted file system (see statfs(2)).  Likewise, the
     getmntinfo64() function returns an array of statfs64 structures describ-ing describing
     ing each currently mounted file system.

     The getmntinfo() function passes its flags argument transparently to
     getfsstat(2), while the getmntinfo64() function passes its flags argument
     transparently to getfsstat64().

RETURN VALUES
     On successful completion, getmntinfo() and getmntinfo64() return a count
     of the number of elements in the array.  The pointer to the array is
     stored into mntbufp.

     If an error occurs, zero is returned and the external variable errno is
     set to indicate the error.  Although the pointer mntbufp will be unmodi-fied, unmodified,
     fied, any information previously returned by getmntinfo() or
     getmntinfo64() will be lost.

ERRORS
     The getmntinfo() and getmntinfo64() functions may fail and set errno for
     any of the errors specified for the library routines getfsstat(2) or
     malloc(3).

SEE ALSO
     getfsstat(2), mount(2), statfs(2), mount(8)

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

BUGS
     The getmntinfo() and getmntinfo64() functions write the array of struc-tures structures
     tures to an internal static object and returns a pointer to that object.
     Subsequent calls to getmntinfo() and getmntinfo64() will modify the same
     object.

     The memory allocated by getmntinfo() and getmntinfo64() cannot be
     free(3)'d by the application.

BSD                              June 9, 1993                              BSD