244 lines
14 KiB
HTML
244 lines
14 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|||
|
|
<!-- Documenting T:NAnt.VisualCpp.Tasks.LinkTask-->
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Language" content="en-ca" />
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../style.css" />
|
|||
|
|
<title><link> Task</title>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
|
|||
|
|
<tr>
|
|||
|
|
<td class="NavBar-Cell">
|
|||
|
|
<a href="http://nant.sourceforge.net">
|
|||
|
|
<b>NAnt</b>
|
|||
|
|
</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../index.html">Help</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../tasks/index.html">Task Reference</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" /> <link></td>
|
|||
|
|
<td class="NavBar-Cell" align="right">
|
|||
|
|
v0.91</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<h1><link></h1>
|
|||
|
|
<p> Links files using <code>link.exe</code>, Microsoft's Incremental Linker. </p>
|
|||
|
|
<p>This task is intended for version 7.00.9466 of <code>link.exe</code>.</p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="table">
|
|||
|
|
<table>
|
|||
|
|
<tr>
|
|||
|
|
<th>Attribute</th>
|
|||
|
|
<th style="text-align: center;">Type</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
<th style="text-align: center;">Required</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top" class="required">output</td>
|
|||
|
|
<td style="text-align: center;">file</td>
|
|||
|
|
<td> The output file. </td>
|
|||
|
|
<td style="text-align: center;">True</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">moduledefinition</td>
|
|||
|
|
<td style="text-align: center;">file</td>
|
|||
|
|
<td> The name of a module-definition file (.def) to be passed to the linker. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">options</td>
|
|||
|
|
<td style="text-align: center;">string</td>
|
|||
|
|
<td> Options to pass to the compiler. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">pdbfile</td>
|
|||
|
|
<td style="text-align: center;">file</td>
|
|||
|
|
<td> A user-specified name for the program database (PDB) that the linker creates. The default file name for the PDB has the base name of the <code>output</code> and the extension .pdb. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">failonerror</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">if</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">timeout</td>
|
|||
|
|
<td style="text-align: center;">int</td>
|
|||
|
|
<td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">unless</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">verbose</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h3>Framework-configurable parameters</h3>
|
|||
|
|
<div class="table">
|
|||
|
|
<table>
|
|||
|
|
<tr>
|
|||
|
|
<th>Attribute</th>
|
|||
|
|
<th style="text-align: center;">Type</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
<th style="text-align: center;">Required</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">exename</td>
|
|||
|
|
<td style="text-align: center;">string</td>
|
|||
|
|
<td> The name of the executable that should be used to launch the external program. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">managed</td>
|
|||
|
|
<td style="text-align: center;">
|
|||
|
|
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
|
|||
|
|
</td>
|
|||
|
|
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">useruntimeengine</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td>
|
|||
|
|
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h3>Nested Elements:</h3>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="delayloaded">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">delayloaded</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Specified DLLs for delay loading. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="delayloaded">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">delayloaded</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="sources">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">sources</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> The list of files to combine into the output file. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="sources">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">sources</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="libdirs">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">libdirs</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> The list of additional library directories to search. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="libdirs">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">libdirs</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="modules">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">modules</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Link the specified modules into this assembly. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="modules">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">modules</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="embeddedresources">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">embeddedresources</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Embed the specified resources into this assembly. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="embeddedresources">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">embeddedresources</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Collection-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="symbols">
|
|||
|
|
</a>
|
|||
|
|
<symbols>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Symbols to add to the symbol table. <h5><symbol></h5><div class="nested-element"><p> Represents a symbol. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The name of the symbol. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be processed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be skipped; otherwise, processed. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5></symbol></h5></div>
|
|||
|
|
<h4></symbols></h4>
|
|||
|
|
<!--Collection-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="ignorelibraries">
|
|||
|
|
</a>
|
|||
|
|
<ignorelibraries>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Names of libraries that you want the linker to ignore when it resolves external references. <h5><library></h5><div class="nested-element"><p> Represents a library. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The name of the library. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be processed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be skipped; otherwise, processed. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5></library></h5></div>
|
|||
|
|
<h4></ignorelibraries></h4>
|
|||
|
|
<!--Array-->
|
|||
|
|
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="arg">
|
|||
|
|
</a>
|
|||
|
|
<arg>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;"><path></td><td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
|
|||
|
|
<<a href="../types/path.html">path</a>>
|
|||
|
|
</h4><div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
|
|||
|
|
</<a href="../types/path.html">path</a>>
|
|||
|
|
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
|
|||
|
|
<arg value="-l -a" />
|
|||
|
|
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
|
|||
|
|
<arg line="-l -a" />
|
|||
|
|
</pre></li><li><p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p><pre class="code">
|
|||
|
|
<arg path="/dir;/dir2:\dir3" />
|
|||
|
|
</pre></li></ul></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="arg">
|
|||
|
|
</a>
|
|||
|
|
</arg>
|
|||
|
|
</h4>
|
|||
|
|
<h3>Examples</h3>
|
|||
|
|
<ul class="examples">
|
|||
|
|
<li>
|
|||
|
|
<p> Combine all object files in the current directory into <code>helloworld.exe</code>. </p>
|
|||
|
|
<pre class="code">
|
|||
|
|
<link output="helloworld.exe">
|
|||
|
|
<sources>
|
|||
|
|
<include name="*.obj" />
|
|||
|
|
</sources>
|
|||
|
|
</link>
|
|||
|
|
</pre>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3>Requirements</h3>
|
|||
|
|
<div style="margin-left: 20px;">
|
|||
|
|
<b>Assembly:</b> NAnt.VisualCppTasks (0.91.4312.0)
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|