<!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 StartsWith-->
<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>string::starts-with 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" /> string::starts-with</td>
<td class="NavBar-Cell" align="right">
v0.92</td>
</tr>
</table>
<h1>string::starts-with</h1>
<p> Tests whether the specified string starts with the specified prefix string. </p>
<h3>Usage</h3>
<code>bool string::starts-with(<span class="parameter">s1</span>, <span class="parameter">s2</span>)
</code>
<p />
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>s1</td>
<td>string</td>
<td>test string</td>
</tr>
<tr>
<td>s2</td>
<td>string</td>
<td>prefix string</td>
</tr>
</table>
</div>
<h3>Return Value</h3>
<b>true</b> when <i>s2</i> is a prefix for the string <i>s1</i>. Meaning, the characters at the beginning of <i>s1</i> are identical to <i>s2</i>; otherwise, <b>false</b>. <h3>Remarks</h3> This function performs a case-sensitive word search using the invariant culture. <h3>Examples</h3><ul class="examples"><li><pre class="code">string::starts-with('testing string', 'test') ==> true</pre></li><li><pre class="code">string::starts-with('testing string', 'testing') ==> true</pre></li><li><pre class="code">string::starts-with('testing string', 'string') ==> false</pre></li><li><pre class="code">string::starts-with('test', 'testing string') ==> false</pre></li></ul><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.92.4543.0)
</div></body>
</html>
