macro/command/strmatch.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <title>strmatch</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>strmatch</h1>

<p>
Matches the target string with the regular expression. <em>(version 4.59 or later)</em>
</p>

<h2>Format</h2>

<pre class="macro-syntax">
strmatch &lt;target string&gt; &lt;string with regular expression&gt;
</pre>

<h2>Remarks</h2>

<p>
Supports <a href="../../reference/RE.txt">Oniguruma Regular Expressions</a>.<br>
This command searches the &lt;target string&gt; with the &lt;string with regular expression&gt;.<br>

The "strmatch" command returns one of the following values in the system variable "result":
</p>

<table>
 <tr>
  <th>Value</th>
  <th>Meaning</th>
 </tr>
 <tr>
  <td>0</td>
  <td>Not matched.</td>
 </tr>
 <tr>
  <td>1</td>
  <td>Matched offset(1origin).</td>
 </tr>
</table>

<p>
The first matched pattern is stored in the system variable "matchstr".<br>
Group matched patterns of regular expressions are stored in 9 system variables from "groupmatchstr1" to "groupmatchstr9".<br>
Also, these system variables will not be changed when the pattern does not match.
</p>

<p>
When a user searches the multi-byte string like as Japanese, the user must configure the regular encoding by using the <a href="regexoption.html">regexoption</a> previously.
</p>

<h2>Example</h2>

<pre class="macro-example">
strmatch 'Microsoft Windows XP [Version 5.1.2600]' '\[(Version (\d+).(\d+).(\d+))\]'

int2str s result
messagebox s 'result'                        ; 22
messagebox matchstr 'matchstr'               ; [Version 5.1.2600]
messagebox groupmatchstr1 'groupmatchstr1'   ; Version 5.1.2600
messagebox groupmatchstr2 'groupmatchstr2'   ; 5
messagebox groupmatchstr3 'groupmatchstr3'   ; 1
messagebox groupmatchstr4 'groupmatchstr4'   ; 2600
</pre>

<h2>See also</h2>
<ul>
  <li><a href="regexoption.html">regexoption</a></li>
  <li><a href="strreplace.html">strreplace</a></li>
  <li><a href="strinsert.html">strinsert</a></li>
  <li><a href="strremove.html">strremove</a></li>
</ul>

</body>
</html>