<!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.Core.Types.PathSet-->
<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><path> Type</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="../types/index.html">Type Reference</a>
<img alt="->" src="../images/arrow.gif" /> <path></td>
<td class="NavBar-Cell" align="right">
v0.92</td>
</tr>
</table>
<h1><path></h1>
<p>
<p> Paths are groups of files and/or directories that need to be passed as a single unit. The order in which parts of the path are specified in the build file is retained, and duplicate parts are automatically suppressed. </p>
</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">id</td>
<td style="text-align: center;">string</td>
<td> The ID used to be referenced later. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">refid</td>
<td style="text-align: center;">string</td>
<td> The ID to use as the reference. </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"> Defines a set of path elements to add to the current path. <p /></div>
<h4>
<a id="path">
</a>
</<a href="../types/path.html">path</a>>
</h4>
<!--Element-->
<h4>
<a id="pathelement">
</a>
<pathelement>
</h4>
<div class="nested-element"> Defines a path element to add to the current path. <p> Represents a nested path element. </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 name of a directory to add to the path. 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 to add to the path. Will be replaced with the absolute path 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> If <b>true</b> then the entry will be added to the path; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;"><path></td><td> A string that will be treated as a path-like string. 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> Opposite of <code>if</code>. If <b>false</b> then the entry will be added to the path; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div><p /></div>
<h4>
<a id="pathelement">
</a>
</pathelement>
</h4>
<h3>Examples</h3>
<ul class="examples">
<li>
<p> Define a global <code><path></code> that can be referenced by other tasks or types. </p>
<pre class="code">
<path id="includes-path">
<pathelement path="%INCLUDE%" />
<pathelement dir="${build.dir}/include" />
</path>
</pre>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.92.4543.0)
</div>
</body>
</html>
