$Sir Wild: Difference between revisions
(Automatically generated page update) |
No edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Test string against a wildcard string</span> | <span class="pageSubtitle">Test string against a wildcard string</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 the [[RegexMatch (String function)]].</p> | <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 <var>[[RegexMatch (String function)|RegexMatch]]</var> function.</p> | ||
<var>$Sir_Wild</var> indicates whether the one string matches a Sirius-style pattern where | <var>$Sir_Wild</var> indicates whether the one string matches a Sirius-style pattern where asterisk (<tt>*</tt>) matches any set of characters, question mark (<tt>?</tt>) matches any single character, and double-quotation mark (<tt>"</tt>) indicates that the following character is to be treated as a literal even if it is one of the three special wildcard characters: <code>* ? "</code>. <var>$Sir_Wild</var> 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 first argument is the string to be tested for a match. This is an optional argument and defaults to null. | ||
| Line 11: | Line 11: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Sir_Wild</span>(<span class="term">string</span>, <span class="term">wildcard</span>) | <p class="syntax"><span class="term">%rc</span> = <span class="literal">$Sir_Wild</span>([<span class="term">string</span>], [<span class="term">wildcard</span>]) | ||
</p> | </p> | ||
<var class="term">%rc</var> is set to 0 or 1. | |||
==Examples== | |||
<var>$Sir_Wild</var> returns either a 1 indicating that the first string matches the second or 0 otherwise. For example, this returns 1: | <var>$Sir_Wild</var> returns either a 1 indicating that the first string matches the second or 0 otherwise. For example, this returns 1: | ||
| Line 31: | Line 31: | ||
<p class="code"> $Sir_Wild('*LOOK', '"*LOO?') | <p class="code"> $Sir_Wild('*LOOK', '"*LOO?') | ||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 45: | Line 43: | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Sir_Wild]] | [[Category:$Functions|$Sir_Wild]] | ||
Revision as of 21:23, 12 April 2013
Test string against a wildcard string
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Wild function is the RegexMatch function.
$Sir_Wild indicates whether the one string matches a Sirius-style pattern where asterisk (*) matches any set of characters, question mark (?) matches any single character, and double-quotation mark (") indicates that the following character is to be treated as a literal even if it is one of the three special wildcard characters: * ? ". $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
%rc = $Sir_Wild([string], [wildcard])
%rc is set to 0 or 1.
Examples
$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?')