1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>CreateArchiveAlias</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/fs/Overview.html">fs</a>::CreateArchiveAlias</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> CreateArchiveAlias(
15     const char * aliasArchiveName,
16     const char * srcArchiveName
17);
18</pre>
19    </div>
20<h2>Parameters</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th><SPAN class="argument">aliasArchiveName</SPAN></th>
33<td>Specifies the archive name that serves as an alias.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th><SPAN class="argument">srcArchiveName</SPAN></th>
38<td>Specifies the name of the mounted archive that is the original source to which the alias refers.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the result of the operation. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>Result::IsSuccess</CODE></th>
52<td>Process was successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultNotFound</CODE></th>
56<td>The specified archive has not been mounted. You must not allow this error to occur in retail products.</td>
57        </tr>
58        <tr>
59<th>Any other value.</th>
60<td>An application bug or some other unexpected error.</td>
61        </tr>
62      </table> </div>
63<h2>Description</h2>
64    <div class="section">
65<p>Enables an archive to be accessed using a different archive name.</p><p>Allows the already-mounted archived named <SPAN class="argument">srcArchiveName</SPAN> to be accessed using the different archive name <SPAN class="argument">aliasArchiveName</SPAN>.</p><p>After you are finished using the alias, call the <CODE><a href="../../nn/fs/Unmount.html">Unmount</a></CODE> function with <SPAN class="argument">aliasArchiveName</SPAN> specified for its argument. Do not call the <CODE>Unmount</CODE> function while you are using the alias for the mounted archive named <SPAN class="argument">srcArchiveName</SPAN>.</p><p>Generally speaking, this function is used for development purposes. For example, if you have an archive that ultimately will be divided into two pieces, but for the sake of convenience want to operate as a single archive during development, you can use this function to create an alias for the single mounted archive so it can be accessed with two different archive names. There will be less changes that need to made to the final source code.</p><!-- write here --></div>
66<h2>Revision History</h2>
67    <div class="section">
68      <dl class="history">
69        <dt>2012/04/13</dt>
70<dd>Initial version.<br />
71        </dd>
72      </dl>
73    </div>
74  <hr><p>CONFIDENTIAL</p></body>
75</html>