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);
DESCRIPTION
The getmntinfo() function returns an array of statfs() structures describing each currently mounted file system (see statfs(2)).
The getmntinfo() function passes its flags argument transparently to getfsstat(2).
RETURN VALUES
On successful completion, getmntinfo() returns 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
unmodified, any information previously returned by getmntinfo() will be lost.
ERRORS
The getmntinfo() function 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() function writes the array of structures to an internal static object and returns a pointer to that object. Subsequent calls
to getmntinfo() will modify the same object.
The memory allocated by getmntinfo() cannot be free(3)'d by the application.
BSD June 9, 1993 BSD
Check Out this Related Man Page
getmntinfo(3) Library Functions Manual getmntinfo(3)NAME
getmntinfo, getmntinfo_r - Get information about mounted file systems
LIBRARY
Standard C Library (libc)
SYNOPSIS
#include <sys/types.h> #include <sys/mount.h>
int getmntinfo(
struct statfs **mntbufp,
int flags);
The following obsolete function is supported only for backward compatibility reasons. You should not use it in new designs. int getm-
ntinfo_r(
struct statfs **mntbufp,
int flags,
int *mntsizep,
int *bufsizep);
PARAMETERS
Points to a location to which the getmntinfo function returns an array of statfs structures that describe each currently mounted file sys-
tem. If you specify an invalid address, [EFAULT] status is returned in errno. If you specify NULL, an invalid memory access occurs. Speci-
fies one of the following flags to be passed transparently to the getfsstat() function: Waits for an update from each file system before
returning information. Information is returned without requesting an update from each file system. Thus, some of the information will be
out of date, but the getfsstat() function will not block waiting for information from a file system that is unable to respond. Points to
the location where the number of mounted file systems is stored. Points to the size of the buffer containing the array of statfs struc-
tures for all mounted file systems.
DESCRIPTION
The getmntinfo() function returns an array of statfs structures describing each currently mounted file system (see the statfs() reference
page). The getmntinfo() function takes a struct statfs **mntbufp, which it sets to a malloc() ed buffer.
The getmntinfo() function passes its flags parameter transparently to getfsstat().
NOTES
The getmntinfo() function stores information on the malloc() ed buffer in a thread-specific buffer. Subsequent calls to this function from
the same thread must therefore use the same buffer argument. The buffer will be overwritten, and possibly moved, on subsequent calls.
The getmntinfo_r() function is an obsolete reentrant version of the getmntinfo() function. Note that you must set the mntbufp parameter to
NULL before its first access by the getmntinfo_r() function. This prevents the free() function from being called on whatever mntbufp
already contains by the first getmntinfo_r() call. You must also set the mntsizep and bufsizep to 0 (zero).
RETURN VALUES
Upon successful completion, the getmntinfo() function returns a count of the number of elements in the array. Upon failure, it returns a
value of 0 (zero) is returned and leaves mntbufp unmodified.
Upon successful completion, the getmntinfo_r() function stores the count of the number of elements in the array into the int pointed to by
mntsizep and returns a value of 0 (zero). Upon failure, it returns a value of -1.
ERRORS
If the getmntinfo() or getmntinfo_r() function fails, errno may be set to the following: The mntbufp parameter points to a non-NULL invalid
address. An I/O error occurred while reading from or writing to the file system. If the bufsizep parameter is invalid. If there is not
enough storage memory in the system. [Tru64 UNIX] The structure pointed to by the mntbufp parameter cannot correctly represent the value
to be returned.
This error can occur in applications compiled on DIGITAL UNIX systems, on Tru64 UNIX systems earlier than Version 5.0, or on any
system while using the __V40_OBJ_COMPAT compiler macro. These applications use a <statfs> structure not compatible with Tru64 UNIX
Version 5.0 for the following fields: f_blocks, f_bfree, f_bavail, f_mntonname, f_mntfromname.
RELATED INFORMATION
Functions: getfsstat(2), statfs(2), mount(2), malloc(3)
Commands: mount(8) delim off
getmntinfo(3)