<!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 GetPathRoot-->
<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::get-path-root Function</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="index.html">Function Reference</a>
<img alt="->" src="../images/arrow.gif" /> path::get-path-root</td>
<td class="NavBar-Cell" align="right">
v0.92</td>
</tr>
</table>
<h1>path::get-path-root</h1>
<p> Gets the root directory of the specified path. </p>
<h3>Usage</h3>
<code>string path::get-path-root(<span class="parameter">path</span>)
</code>
<p />
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>path</td>
<td>string</td>
<td>The path from which to obtain root directory information.</td>
</tr>
</table>
</div>
<h3>Return Value</h3> A <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a> containing the root directory of <i>path</i>, such as "C:\", or an empty <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a> if <i>path</i> does not contain root directory information. <h3>Exceptions</h3>
The function will fail in any of the following circumstances:
<div style="margin-left: 40px;"><ul><li><i>path</i> contains invalid characters, or is empty.</li></ul></div><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.92.4543.0)
</div></body>
</html>
