gen/getmntinfo.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getmntinfo.3        8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/gen/getmntinfo.3,v 1.12 2002/12/19 09:40:21 ru Exp $
  34 .\"
  35 .Dd June 9, 1993
  36 .Dt GETMNTINFO 3
  37 .Os
  38 .Sh NAME
  39 .Nm getmntinfo
  40 .Nd get information about mounted file systems
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/param.h
  45 .In sys/ucred.h
  46 .In sys/mount.h
  47 .Ft int
  48 .Fn getmntinfo "struct statfs **mntbufp" "int flags"
  49 .Ft int
  50 .Fn getmntinfo64 "struct statfs64 **mntbufp" "int flags"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getmntinfo
  54 function
  55 returns an array of
  56 .Ft statfs
  57 structures describing each currently mounted file system (see
  58 .Xr statfs 2 ) .
  59 Likewise, the
  60 .Fn getmntinfo64
  61 function
  62 returns an array of
  63 .Ft statfs64
  64 structures describing each currently mounted file system.
  65 .Pp
  66 The
  67 .Fn getmntinfo
  68 function
  69 passes its
  70 .Fa flags
  71 argument transparently to
  72 .Xr getfsstat 2 ,
  73 while the
  74 .Fn getmntinfo64
  75 function
  76 passes its
  77 .Fa flags
  78 argument transparently to
  79 .Fn getfsstat64 .
  80 .Sh RETURN VALUES
  81 On successful completion,
  82 .Fn getmntinfo
  83 and
  84 .Fn getmntinfo64
  85 return a count of the number of elements in the array.
  86 The pointer to the array is stored into
  87 .Fa mntbufp .
  88 .Pp
  89 If an error occurs, zero is returned and the external variable
  90 .Va errno
  91 is set to indicate the error.
  92 Although the pointer
  93 .Fa mntbufp
  94 will be unmodified, any information previously returned by
  95 .Fn getmntinfo
  96 or
  97 .Fn getmntinfo64
  98 will be lost.
  99 .Sh ERRORS
 100 The
 101 .Fn getmntinfo
 102 and
 103 .Fn getmntinfo64
 104 functions
 105 may fail and set errno for any of the errors specified for the library
 106 routines
 107 .Xr getfsstat 2
 108 or
 109 .Xr malloc 3 .
 110 .Sh SEE ALSO
 111 .Xr getfsstat 2 ,
 112 .Xr mount 2 ,
 113 .Xr statfs 2 ,
 114 .Xr mount 8
 115 .Sh HISTORY
 116 The
 117 .Fn getmntinfo
 118 function first appeared in
 119 .Bx 4.4 .
 120 .Sh BUGS
 121 The
 122 .Fn getmntinfo
 123 and
 124 .Fn getmntinfo64
 125 functions write the array of structures to an internal static object
 126 and returns
 127 a pointer to that object.
 128 Subsequent calls to
 129 .Fn getmntinfo
 130 and
 131 .Fn getmntinfo64
 132 will modify the same object.
 133 .Pp
 134 The memory allocated by
 135 .Fn getmntinfo
 136 and
 137 .Fn getmntinfo64
 138 cannot be
 139 .Xr free 3 Ns 'd
 140 by the application.