1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<title>FS_SuspendArchive</title>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</head>
10<body>
11<h1 align="left">FS_SuspendArchive <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
12<h2>Syntax</h2>
13<dl>
14  <dd>
15<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
16  <BR>
17  <CODE>BOOL	FS_SuspendArchive(<A href="../fs_archive_type.html">FSArchive</a> *p_arc);</CODE><br>
18  <br>
19  </dd>
20</dl>
21<h2>Arguments</h2>
22<TABLE border="1" width="100%">
23  <TBODY>
24    <TR>
25      <TD width="13%"><EM><STRONG>p_arc</STRONG></EM></TD>
26      <TD width="87%">Address of the <A href="../fs_archive_type.html"><code>FSArchive</code></a> structure.</TD>
27    </TR>
28  </TBODY>
29</TABLE>
30<h2>Return Values</h2>
31<p><code>FALSE</code> if archive is in the suspended state before the change. <code>TRUE</code> if not.</p>
32<H2>Description</H2>
33<P>Sets the archive to the halted state. While the archive is stopped, commands that are sent from the file system are stored in the process-wait state.<br /> To return the archive from the halted state to the normal state, call <code><a href="FS_ResumeArchive.html">FS_ResumeArchive</a></code>. In order to control the archive state immediately after the archive is loaded, you must call this function before you call the <code><a href="FS_LoadArchive.html">FS_LoadArchive</a></code> function. <BR>
34</P>
35<h2>See Also</h2>
36<p><CODE></CODE></p>
37<H2>Revision History</H2>
38<P>
392004/07/12 Changed the return value type<br /> 2004/06/30 Initial Version
40</P>
41<hr><p>CONFIDENTIAL</p></body>
42</html>
43