1<html> 2 3<head> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META name="GENERATOR" content="Microsoft FrontPage 5.0"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css"> 8<title>DARCHCreate</title> 9</head> 10 11<body> 12 13<h1>DARCHCreate</h1> 14 15<h2>Syntax</h2> 16 17<dl> 18<dd><pre><code>#include <revolution/darch.h></code></pre> 19 </dd> 20<dd><pre><code>BOOL DARCHCreate(void* <i>arcStart</i>, u32 <i>arcSize</i>, const DARCHFileInfo* <i>fileInfo</i>, const u32 <i>fileInfoNum</i>);</code></pre> 21 </dd> 22</dl> 23<h2>Arguments</h2> 24<p> 25<table border="1" cellpadding="3" cellspacing="0"> 26 <tr> 27<td width="120" bgcolor="#ffffe8"><code><b><i>arcStart</i></b></code></td> 28<td width="520">Starting address of the archive file image.</td> 29 </tr> 30 <tr> 31<td width="120" bgcolor="#ffffe8"><code><b><i>arcSize</i></b></code></td> 32<td width="520">Size of the archive file image.</td> 33 </tr> 34 <tr> 35<td width="120" bgcolor="#ffffe8"><code><b><i>fileInfo</i></b></code></td> 36<td width="520">Pointer to structure containing file information of a file to archive.</td> 37 </tr> 38 <tr> 39<td width="120" bgcolor="#ffffe8"><code><b><i>fileInfoNum</i></b></code></td> 40<td width="520">Number of files to archive.</td> 41 </tr> 42 43</table> 44</p> 45 46<h2>Return Values</h2> 47<p> Returns <CODE>TRUE</CODE> if successful, <CODE>FALSE</CODE> if unsuccessful.</p> 48<h2>Description</h2> 49<P>The <CODE>DARCHCreate</CODE> function archives the file specified by the <code><A href="DARCHFileInfo.html">DARCHFileInfo</A></code> structure and generates an archive file image. <br>To generate the image, the size and starting address of the buffer in which the archive file image is placed must be specified.</P> 50<P>The size of the archive file image can be obtained using the <code><a href="DARCHGetArcSize.html">DARCHGetArcSize</a></code> function.</P> 51 52<h2>Note</h2> 53<p>If the number of characters of the absolute path of the file to be archived is larger than the file size, a <CODE><B>DARCHCreate():allocation failed.</B></CODE> error is returned because sufficient buffer memory could not be allocated.<br> 54 55After the archive file image is created, the buffer memory area will be overwritten by the archive file image.</p> 56 57<h2>See Also</h2> 58<p><code><a href="DARCHGetArcSize.html">DARCHGetArcSize</a></code>, <code><a href="DARCHFileInfo.html">DARCHFileInfo</a></code></p> 59 60<H2>Revision History</H2> 61<P> 622007/10/10 Initial version. 63</P> 64<hr><p>CONFIDENTIAL</p></body> 65</html>