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 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>FS_SetArchiveProc</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_SetArchiveProc <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
20  <BR>
21  <CODE>void	FS_SetArchiveProc(struct <A href="../fs_archive_type.html">FSArchive</a> *p_arc,
22	<A href="../fs_archive_proc_func_type.html">FS_ARCHIVE_PROC_FUNC</a> proc, u32 flags);</CODE><br>
23  <br>
24  </dd>
25</dl>
26
27<h2>Arguments</h2>
28<TABLE border="1" width="100%">
29  <TBODY>
30    <TR>
31      <TD width="13%"><EM><STRONG>p_arc</STRONG></EM></TD>
32      <TD width="87%">Address of the <A href="../fs_archive_type.html"><code>FSArchive</code></a> structure.</TD>
33    </TR>
34    <TR>
35      <TD width="13%"><EM><STRONG>proc</STRONG></EM></TD>
36      <TD width="87%">The user procedure being registered.
37	  The function set here will be called from inside the FS function that uses archive commands.</TD>
38    </TR>
39    <TR>
40      <TD width="13%"><EM><STRONG>flags</STRONG></EM></TD>
41      <TD width="87%">A bitset that indicates the type of command to be sent to the user procedure.<BR>
42	  This is specified as a combination of the <CODE>FS_ARCHIVE_PROC_*</CODE> flags.</TD>
43    </TR>
44  </TBODY>
45</TABLE>
46
47<h2>Return Values</h2>
48<p>None.</p>
49
50<H2>Description</H2>
51<P>Specifies a user procedure in an archive. User procedures are called as callback functions when the archive processes commands or enters certain states. During the processing of the callback, the commands themselves can be replaced by independent processes or things can be left to the default implementation. For more information about the operation of each command, see <code><A href="../fs_command_type_const.html">FSCommandType</a></code>. <BR>
52<h2>See Also</h2>
53<p>
54<code><a href="../fs_archive_type.html">FSArchive</a></code>, <code><a href="../fs_command_type_const.html">FSCommandType</a></code>, <code><a href="../fs_archive_proc_consts.html">FS_ARCHIVE_PROC_*</a></code>, <code><a href="FS_LoadArchive.html">FS_LoadArchive</a></code>, <code><a href="FS_UnloadArchive.html">FS_UnloadArchive</a></code>
55</p>
56<H2>Revision History</H2>
57<P>
582005/06/01 Added text indicating that procedure is called from inside a FS function.<br> 2004/07/12 Initial version.</P>
59<hr><p>CONFIDENTIAL</p></body>
60</html>
61