1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>FS_COMMAND_CLOSEFILE</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_COMMAND_CLOSEFILE <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
15<h2>Definition</h2>
16
17<dl>
18  <dd>
19  <BR>
20  <CODE>FSResult FS_ARCHIVE_PROC_FUNC(FSFile *p_file, FSCommandType command /*
21  = FS_COMMAND_CLOSEFILE */);<br>
22  </CODE><br>
23  </dd>
24</dl>
25
26<H2>Description</H2>
27<P>Operating specifications for the archive command <code>FS_COMMAND_CLOSEFILE</code> are shown below: <BR> <BR>
28
29<HR>
30<B>Arguments passed to this command</B>
31<BLOCKQUOTE>
32<PRE>This command takes as a command argument the variable <code>arg.closefile</code> that is stored in <code>p_file</code>.<br />
33This variable is defined in <code>nitro/fs/file.h</code> as shown below:
34
35typedef struct
36{
37    u32    reserved;
38} FSCloseFileInfo;</code></PRE>
39</BLOCKQUOTE>
40<BLOCKQUOTE>Argument content is listed below:
41</BLOCKQUOTE>
42<CENTER>
43<TABLE border="1" width="50%">
44  <TBODY>
45    <TR>
46      <TD style="text-align : center;" width="95">Arguments</TD>
47      <TD style="text-align : center;" width="522">Content</TD>
48    </TR>
49    <TR>
50      <TD width="95" style="text-align : center;">reserved</TD>
51      <TD width="522">Not used</TD>
52    </TR>
53  </TBODY>
54</TABLE>
55</CENTER>
56<BR>
57<HR>
58<B>Actions required of this command</B>
59<BLOCKQUOTE>
60<PRE><code>p_file</code> is a handle that always holds file information in <code>prop.file</code>.<br />
61Based on this information, in order to close a file it carries out required, special processes.</PRE>
62</BLOCKQUOTE>
63<HR>
64<B>Default Implementation</B>
65<BLOCKQUOTE>None</BLOCKQUOTE>
66<HR>
67<B>Command Results</B><BR>
68
69<BLOCKQUOTE>
70<PRE>If <code>FS_RESULT_SUCCESS</code> is returned by the command, <code>p_file</code> will no longer be a handle that holds file information.
71From that point the <code>FS_IsFile</code> function will return FALSE.
72This is the same state that exists immediately after the <code><a href="../file/FS_InitFile.html">FS_InitFile</a></code> function is called.</PRE>
73</BLOCKQUOTE>
74<HR>
75<B>Functions that use this command</B><BR>
76<BLOCKQUOTE>FS_CloseFile</BLOCKQUOTE>
77<h2>See Also</h2>
78<p><code><a href="../fs_archive_type.html">FSArchive</a></code>, <code><a href="../fs_archive_proc_func_type.html">FS_ARCHIVE_PROC_FUNC</a></code>, <code><a href="../fs_command_type_const.html">FS_COMMAND_*</a></code>, <code><a href="../archive/FS_SetArchiveProc.html">FS_SetArchiveProc</a></code></p>
79
80<H2>Revision History</H2>
81<P>2004/07/12 Initial version.</P>
82<hr><p>CONFIDENTIAL</p></body>
83</html>
84