RegexString (Regex property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
No edit summary
 
Line 1: Line 1:
{{Template:Regex:RegexString subtitle}}
{{Template:Regex:RegexString subtitle}}


This page is [[under construction]].
This method returns the regex string value specified in the [[New (Regex constructor)|Regex constructor]] call.
==Syntax==
==Syntax==
{{Template:Regex:RegexString syntax}}
{{Template:Regex:RegexString syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%string</th><td>string</td></tr>
<tr><th>%string</th><td>The regex string value specified in the Regex constructor call.</td></tr>
<tr><th>regex</th>
<tr><th>regex</th>
<td><var>Regex</var> object</td></tr>
<td>The <var>Regex</var> object.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<li>If the regular expresion specified in the constructor call was Unicode, this method causes request cancellation. To test if a <var>Regex</var> object was created with a Unicode regular expression check the [[IsUnicode (Regex property)|IsUnicode property]].</li>
</ul>
==Examples==
==Examples==
The following example:
<p class="code">b
%regex    is object regex
%regex = new("([a-z]{3,}\d{3,})", options="is")
print %regex:regexString
end
</p>
displays:
<p class="code">([a-z]{3,}\d{3,})
</p>
==See also==
==See also==
{{Template:Regex:RegexString footer}}
{{Template:Regex:RegexString footer}}
[[Category:Regular expression processing]]

Latest revision as of 18:21, 23 March 2022

String regular expression (Regex class)


This method returns the regex string value specified in the Regex constructor call.

Syntax

%string = regex:RegexString

Syntax terms

%stringThe regex string value specified in the Regex constructor call.
regex The Regex object.

Usage notes

  • If the regular expresion specified in the constructor call was Unicode, this method causes request cancellation. To test if a Regex object was created with a Unicode regular expression check the IsUnicode property.

Examples

The following example:

b %regex is object regex %regex = new("([a-z]{3,}\d{3,})", options="is") print %regex:regexString end

displays:

([a-z]{3,}\d{3,})

See also