lib/libc/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.8.2.4 2003/03/13 18:05:37 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/getmntinfo.3,v 1.5 2008/06/03 12:40:09 swildner Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt GETMNTINFO 3
  38 .Os
  39 .Sh NAME
  40 .Nm getmntinfo
  41 .Nd get information about mounted file systems
  42 .Nm getmntvinfo
  43 .Nd get extended information about mounted file systems
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In sys/param.h
  48 .In sys/ucred.h
  49 .In sys/mount.h
  50 .Ft int
  51 .Fn getmntinfo "struct statfs **mntbufp" "int flags"
  52 .Ft int
  53 .Fn getmntvinfo "struct statfs **mntbufp" "struct statvfs **mntvbufp" "int flags"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn getmntinfo
  57 function
  58 returns an array of
  59 .Fn statfs
  60 structures describing each currently mounted file system (see
  61 .Xr statfs 2 ) .
  62 .Pp
  63 The
  64 .Fn getmntinfo
  65 function
  66 passes its
  67 .Fa flags
  68 argument transparently to
  69 .Xr getfsstat 2 .
  70 .Sh RETURN VALUES
  71 On successful completion,
  72 .Fn getmntinfo
  73 returns a count of the number of elements in the array.
  74 The pointer to the array is stored into
  75 .Fa mntbufp .
  76 .Pp
  77 If an error occurs, zero is returned and the external variable
  78 .Va errno
  79 is set to indicate the error.
  80 Although the pointer
  81 .Fa mntbufp
  82 will be unmodified, any information previously returned by
  83 .Fn getmntinfo
  84 will be lost.
  85 .Pp
  86 The
  87 .Fn getmntvinfo
  88 function
  89 returns an array of
  90 .Fn statfs
  91 and
  92 .Fn statvfs
  93 structures describing each currently mounted file system (see
  94 .Xr statfs 2 ) ,
  95 and otherwise works like
  96 .Fn getmntinfo .
  97 .Sh ERRORS
  98 The
  99 .Fn getmntinfo
 100 function may fail and set
 101 .Va errno
 102 for any of the errors specified for the library routines
 103 .Xr getfsstat 2
 104 .Xr getvfsstat 2
 105 or
 106 .Xr malloc 3 .
 107 .Sh SEE ALSO
 108 .Xr getfsstat 2 ,
 109 .Xr mount 2 ,
 110 .Xr statfs 2 ,
 111 .Xr mount 8
 112 .Sh HISTORY
 113 The
 114 .Fn getmntinfo
 115 function first appeared in
 116 .Bx 4.4 .
 117 .Sh BUGS
 118 The
 119 .Fn getmntinfo
 120 function writes the array of structures to an internal static object
 121 and returns
 122 a pointer to that object.
 123 Subsequent calls to
 124 .Fn getmntinfo
 125 will modify the same object.
 126 .Pp
 127 The memory allocated by
 128 .Fn getmntinfo
 129 cannot be
 130 .Xr free 3 Ns 'd
 131 by the application.