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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getmntinfo.3        8.1 (Berkeley) 6/9/93
  29 .\"
  30 .Dd December 27, 2016
  31 .Dt GETMNTINFO 3
  32 .Os
  33 .Sh NAME
  34 .Nm getmntinfo
  35 .Nd get information about mounted file systems
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/ucred.h
  41 .In sys/mount.h
  42 .Ft int
  43 .Fn getmntinfo "struct statfs **mntbufp" "int mode"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn getmntinfo
  47 function
  48 returns an array of
  49 .Fn statfs
  50 structures describing each currently mounted file system (see
  51 .Xr statfs 2 ) .
  52 .Pp
  53 The
  54 .Fn getmntinfo
  55 function
  56 passes its
  57 .Fa mode
  58 argument transparently to
  59 .Xr getfsstat 2 .
  60 .Sh RETURN VALUES
  61 On successful completion,
  62 .Fn getmntinfo
  63 returns a count of the number of elements in the array.
  64 The pointer to the array is stored into
  65 .Fa mntbufp .
  66 .Pp
  67 If an error occurs, zero is returned and the external variable
  68 .Va errno
  69 is set to indicate the error.
  70 Although the pointer
  71 .Fa mntbufp
  72 will be unmodified, any information previously returned by
  73 .Fn getmntinfo
  74 will be lost.
  75 .Sh ERRORS
  76 The
  77 .Fn getmntinfo
  78 function
  79 may fail and set errno for any of the errors specified for the library
  80 routines
  81 .Xr getfsstat 2
  82 or
  83 .Xr malloc 3 .
  84 .Sh SEE ALSO
  85 .Xr getfsstat 2 ,
  86 .Xr mount 2 ,
  87 .Xr statfs 2 ,
  88 .Xr mount 8
  89 .Sh HISTORY
  90 The
  91 .Fn getmntinfo
  92 function first appeared in
  93 .Bx 4.4 .
  94 .Sh BUGS
  95 The
  96 .Fn getmntinfo
  97 function writes the array of structures to an internal static object
  98 and returns
  99 a pointer to that object.
 100 Subsequent calls to
 101 .Fn getmntinfo
 102 will modify the same object.
 103 .Pp
 104 The memory allocated by
 105 .Fn getmntinfo
 106 cannot be
 107 .Xr free 3 Ns 'd
 108 by the application.