ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/statvfsu.htm

196 lines
6.3 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>QlgStatvfs()--Get File System Information (using NLS-enabled path
name)</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records --><!-- file cleaned -->
<!-- Created by Yvonne Griffin for V5R1-->
<!-- This file has undergone html cleanup June 2002 by JET -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>QlgStatvfs()--Get File System Information (using NLS-enabled path
name)</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;sys/statvfs.h&gt;
int QlgStatvfs(Qlg_Path_Name_T <em>*path</em>, struct statvfs <em>*buf</em>);
</pre>
&nbsp;&nbsp;Service Program Name: QP0LLIB1<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Conditional; see Usage Notes for <a href="statvfs.htm">statvfs()</a>.<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>QlgStatvfs()</strong> function, like the <strong>
statvfs()</strong> function, gets status information about the file system that
contains the file named by the <em>path</em> argument. The difference is that
the <strong>QlgStatvfs()</strong> function takes a pointer to a Qlg_Path_Name_T
structure, while <strong>statvfs()</strong> takes a pointer to a character
string.</p>
<p>Limited information on the <em>path</em> parameter is provided here. For
more information on the <em>path</em> parameter and for a discussion of other
parameters, authorities required, return values, and related information, see
<a href="statvfs.htm">statvfs()</a>--Get File System Information.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong><em>path</em></strong></dt>
<dd>(Input) A pointer to a Qlg_Path_Name_T structure that contains a path name
or a pointer to a path name of the file from which file system information is
required. For more information on the Qlg_Path_Name_T structure, see <a href=
"../apiref/pns.htm">Path name format</a>.</dd>
</dl>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="statvfs.htm">statvfs()</a>--Get File System Information</li>
<li><a href="statvfs64u.htm">QlgStatvfs64()</a>--Get File System Information
(64-Bit Enabled and using NLS-enabled path name)</li>
<li><a href="chmodu.htm">QlgChmod()</a>--Change File Authorizations (using
NLS-enabled path name)</li>
<li><a href="chownu.htm">QlgChown()</a>--Change Owner and Group of File (using
NLS-enabled path name)</li>
<li><a href="creatu.htm">QlgCreat()</a>--Create or Rewrite File (using
NLS-enabled path name)</li>
<li><a href="linku.htm">QlgLink()</a>--Create Link to File (using NLS-enabled
path name)</li>
<li><a href="utimeu.htm">QlgUtime()</a>--Set File Access and Modification Times
(using NLS-enabled path name)</li>
<li><a href="qp0lunlk.htm">Qp0lUnlink()</a>--Remove Link to File</li>
</ul>
<br>
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example gets status information about a file system:</p>
<pre>
#include &lt;sys/statvfs.h&gt;
#include &lt;stdio.h&gt;
#include &lt;sys/types.h&gt;
main() {
struct statvfs info;
#define mypath "/"
const char US_const[3]= "US";
const char Language_const[4] ="ENU";
typedef struct pnstruct
{
Qlg_Path_Name_T qlg_struct;
char pn[100]; /* This array size must be &gt;= the */
/* length of the path name or must */
/* be a pointer to the path name. */
};
struct pnstruct path;
/***************************************************************/
/* Initialize Qlg_Path_Name_T parameters */
/***************************************************************/
memset((void*)path name, 0x00, sizeof(struct pnstruct));
path.qlg_struct.CCSID = 37;
memcpy(path.qlg_struct.Country_ID,US_const,2);
memcpy(path.qlg_struct.Language_ID,Language_const,3);
path.qlg_struct.Path_Type = QLG_CHAR_SINGLE;
path.qlg_struct.Path_Length = sizeof(mypath)-1;
path.qlg_struct.Path_Name_Delimiter[0] = '/';
memcpy(path.pn,mypath,sizeof(mypath)-1);
if (-1 == QlgStatvfs((Qlg_Path_Name_T *)path name, &amp;info))
perror("QlgStatvfs() error");
else {
puts("QlgStatvfs() returned the following information");
puts("about the Root ('/') file system:");
printf(" f_bsize : %u\n", info.f_bsize);
printf(" f_blocks : %08X%08X\n",
*((int *)&amp;info.f_blocks[0]),
*((int *)&amp;info.f_blocks[4]));
printf(" f_bfree : %08X%08X\n",
*((int *)&amp;info.f_bfree[0]),
*((int *)&amp;info.f_bfree[4]));
printf(" f_files : %u\n", info.f_files);
printf(" f_ffree : %u\n", info.f_ffree);
printf(" f_fsid : %u\n", info.f_fsid);
printf(" f_flag : %X\n", info.f_flag);
printf(" f_namemax : %u\n", info.f_namemax);
printf(" f_pathmax : %u\n", info.f_pathmax);
printf(" f_basetype : %s\n", info.f_basetype);
}
}
</pre>
<p>Output: The following information will vary from file system to file
system.</p>
<pre>
QlgStatvfs() returned the following information
about the Root ('/') file system:
f_bsize : 4096
f_blocks : 00000000002BF800
f_bfree : 0000000000091703
f_files : 4294967295
f_ffree : 4294967295
f_fsid : 0
f_flag : 1A
f_namemax : 255
f_pathmax : 4294967295
f_basetype : "root" (/)
</pre>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>