Files
oldlinux-files/study/Ref-docs/POSIX/susv3/basedefs/sys/statvfs.h.html
2024-02-19 00:25:23 -05:00

149 lines
5.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>&lt;sys/statvfs.h&gt;</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../../jscript/dotcode.js">
</script>
<basefont size="3"> <a name="&lt;sys/statvfs.h&gt;"></a> <a name="tag_13_63"></a><!-- &lt;sys/statvfs.h&gt; -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_13_63_01"></a>NAME</h4>
<blockquote>sys/statvfs.h - VFS File System information structure</blockquote>
<h4><a name="tag_13_63_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;sys/statvfs.h&gt; <img src="../../images/opt-end.gif" alt="[Option End]" border=
"0"></tt></div>
</blockquote>
<h4><a name="tag_13_63_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>&lt;sys/statvfs.h&gt;</i> header shall define the <b>statvfs</b> structure that includes at least the following
members:</p>
<pre>
<tt>unsigned long f_bsize </tt> File system block size. <tt>
unsigned long f_frsize </tt> Fundamental file system block size. <tt>
fsblkcnt_t f_blocks </tt> Total number of blocks on file system in units of <i>f_frsize.</i> <tt>
fsblkcnt_t f_bfree </tt> Total number of free blocks. <tt>
fsblkcnt_t f_bavail </tt> Number of free blocks available to <tt>
</tt> non-privileged process. <tt>
fsfilcnt_t f_files </tt> Total number of file serial numbers. <tt>
fsfilcnt_t f_ffree </tt> Total number of free file serial numbers. <tt>
fsfilcnt_t f_favail </tt> Number of file serial numbers available to <tt>
</tt> non-privileged process. <tt>
unsigned long f_fsid </tt> File system ID. <tt>
unsigned long f_flag </tt> Bit mask of <i>f_flag</i> values. <tt>
unsigned long f_namemax </tt> Maximum filename length. <tt>
</tt>
</pre>
<p>The <b>fsblkcnt_t</b> and <b>fsfilcnt_t</b> types shall be defined as described in <a href=
"../sys/types.h.html#tag_13_67"><i>&lt;sys/types.h&gt;</i></a> .</p>
<p>The following flags for the <i>f_flag</i> member shall be defined:</p>
<dl compact>
<dt>ST_RDONLY</dt>
<dd>Read-only file system.</dd>
<dt>ST_NOSUID</dt>
<dd>Does not support <a href="../../functions/setuid.html"><i>setuid</i>()</a>/ <a href=
"../../functions/setgid.html"><i>setgid</i>()</a> semantics.</dd>
</dl>
<p>The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.</p>
<pre>
<tt>int statvfs(const char *restrict, struct statvfs *restrict);
int fstatvfs(int, struct statvfs *);
</tt>
</pre>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_13_63_04"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_63_05"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_63_06"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_63_07"></a>SEE ALSO</h4>
<blockquote>
<p><a href="../sys/types.h.html#tag_13_67"><i>&lt;sys/types.h&gt;</i></a> , the System Interfaces volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../../functions/fstatvfs.html"><i>fstatvfs</i>()</a>, <a href=
"../../functions/statvfs.html"><i>statvfs</i>()</a></p>
</blockquote>
<h4><a name="tag_13_63_08"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>
<h4><a name="tag_13_63_09"></a>Issue 5</h4>
<blockquote>
<p>The type of <i>f_blocks</i>, <i>f_bfree</i>, and <i>f_bavail</i> is changed from <b>unsigned long</b> to <b>fsblkcnt_t</b>; the
type of <i>f_files</i>, <i>f_ffree</i>, and <i>f_favail</i> is changed from <b>unsigned long</b> to <b>fsfilcnt_t</b>.</p>
</blockquote>
<h4><a name="tag_13_63_10"></a>Issue 6</h4>
<blockquote>
<p>The Open Group Corrigendum U035/5 is applied. In the DESCRIPTION, the types <b>fsblkcnt_t</b> and <b>fsfilcnt_t</b> have been
described.</p>
<p>The <b>restrict</b> keyword is added to the prototype for <a href="../../functions/statvfs.html"><i>statvfs</i>()</a>.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../../mindex.html">Main Index</a> | <a href="../../basedefs/contents.html">XBD</a> | <a href=
"../../utilities/contents.html">XCU</a> | <a href="../../functions/contents.html">XSH</a> | <a href=
"../../xrat/contents.html">XRAT</a> ]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>