$Sir Wild: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Test string against a wildcard string<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Test string against a wildcard string<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Wild function is [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Wild function is the [[RegexMatch (String function)]].</p> | ||
$Sir_Wild indicates whether the one string matches a Sirius-style pattern where a "*" matches any set of characters, a "?" matches any single character and a """ indicates that the following character is to be treated as a literal even if it is one of the three special wildcard characters, that is "*", "?" or """. $Sir_Wild takes two string arguments and returns either a 0 or 1. | $Sir_Wild indicates whether the one string matches a Sirius-style pattern where a "*" matches any set of characters, a "?" matches any single character and a """ indicates that the following character is to be treated as a literal even if it is one of the three special wildcard characters, that is "*", "?" or """. $Sir_Wild takes two string arguments and returns either a 0 or 1. | ||
Line 11: | Line 9: | ||
The second argument is the string, possibly containing wildcards, against which the first argument is to be tested. This is an optional argument and defaults to null. | The second argument is the string, possibly containing wildcards, against which the first argument is to be tested. This is an optional argument and defaults to null. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RC = $Sir_Wild(string, wildcard) | <p class="syntax"><section begin="syntax" /> %RC = $Sir_Wild(string, wildcard) | ||
Line 18: | Line 17: | ||
<p class="caption"> %RC is set to 0 or 1.</p> | <p class="caption"> %RC is set to 0 or 1.</p> | ||
$Sir_Wild returns either a 1 indicating that the first string matches the second or 0 otherwise. For example, this returns 1: | |||
<p class="code"> $Sir_Wild('Ahab', 'A*') | <p class="code"> $Sir_Wild('Ahab', 'A*') | ||
</p> | </p> | ||
This returns 0: | |||
<p class="code"> $Sir_Wild('Starbuck', 'A*') | <p class="code"> $Sir_Wild('Starbuck', 'A*') | ||
</p> | </p> | ||
This returns 1: | |||
<p class="code"> $Sir_Wild('*LOOK', '"*LOO?') | <p class="code"> $Sir_Wild('*LOOK', '"*LOO?') | ||
</p> | </p> | ||
$Sir_Wild is new in Version 6.3 of the ''[[Sirius Mods]]''. | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[Sirius functions]]</li> | ||
Line 47: | Line 43: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
<p class="caption">Products authorizing $Sir_Wild | <p class="caption">Products authorizing $Sir_Wild | ||
</p> | </p> | ||
[[Category:$Functions|$Sir_Wild]] | [[Category:$Functions|$Sir_Wild]] |
Revision as of 19:36, 8 February 2011
<section begin="desc" />Test string against a wildcard string<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Wild function is the RegexMatch (String function).
$Sir_Wild indicates whether the one string matches a Sirius-style pattern where a "*" matches any set of characters, a "?" matches any single character and a """ indicates that the following character is to be treated as a literal even if it is one of the three special wildcard characters, that is "*", "?" or """. $Sir_Wild takes two string arguments and returns either a 0 or 1.
The first argument is the string to be tested for a match. This is an optional argument and defaults to null.
The second argument is the string, possibly containing wildcards, against which the first argument is to be tested. This is an optional argument and defaults to null.
Syntax
<section begin="syntax" /> %RC = $Sir_Wild(string, wildcard) <section end="syntax" />
$Sir_Wild returns either a 1 indicating that the first string matches the second or 0 otherwise. For example, this returns 1:
$Sir_Wild('Ahab', 'A*')
This returns 0:
$Sir_Wild('Starbuck', 'A*')
This returns 1:
$Sir_Wild('*LOOK', '"*LOO?')
$Sir_Wild is new in Version 6.3 of the Sirius Mods.