StringRegExp - Revision history

Jaberwocky6669 at 06:34, 23 August 2013

2013-08-23T06:34:37Z

← Older revision		Revision as of 06:34, 23 August 2013
Line 1:		Line 1:
	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. -->
			<!-- Not meant to be user editable. -->
			<!-- If there is an error here then that means that there is an error in the helpfile. -->
			<!-- Report it to Trac with category 'Documentation'. -->
			<!-- See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
	<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>		<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

Line 14:		Line 18:


	<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>		===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
	{\| class='wikitable'		{\| class='wikitable'
	\|-		\|-
Line 42:		Line 46:


	<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>		===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
	''Flag = 0 :''		''Flag = 0 :''

Line 82:		Line 86:


	<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>		===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
	The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.		The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.

Line 93:		Line 97:
	Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.		Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.

	Complete description can be found ''''''		Complete description can be found '''[http://www.autoitscript.com/autoit3/pcrepattern.html here]'''

	'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.		'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.
Line 143:		Line 147:
	\| \\ \|\| Match an actual backslash (\).		\| \\ \|\| Match an actual backslash (\).
	\|-		\|-
	\| \a \|\| Alarm, that is, the BEL character ((7)).		\| \a \|\| Alarm, that is, the BEL character ([[Chr]](7)).
	\|-		\|-
	\| \A \|\| Match only at beginning of string.		\| \A \|\| Match only at beginning of string.
Line 157:		Line 161:
	\| \D \|\| Match any non-digit.		\| \D \|\| Match any non-digit.
	\|-		\|-
	\| \e \|\| Match an escape character ((27)).		\| \e \|\| Match an escape character ([[Chr]](27)).
	\|-		\|-
	\| \E \|\| end case modification.		\| \E \|\| end case modification.
	\|-		\|-
	\| \f \|\| Match an formfeed character ((12)).		\| \f \|\| Match an formfeed character ([[Chr]](12)).
	\|-		\|-
	\| \G \|\| first matching position in subject.		\| \G \|\| first matching position in subject.
Line 169:		Line 173:
	\| \H \|\| any character that is not a horizontal whitespace character.		\| \H \|\| any character that is not a horizontal whitespace character.
	\|-		\|-
	\| \n \|\| Match a linefeed (@LF, (10)).		\| \n \|\| Match a linefeed (@LF, [[Chr]](10)).
	\|-		\|-
	\| \K \|\| reset start of match.		\| \K \|\| reset start of match.
Line 177:		Line 181:
	\| \Q \|\| quote (disable) pattern metacharacters till \E.		\| \Q \|\| quote (disable) pattern metacharacters till \E.
	\|-		\|-
	\| \r \|\| Match a carriage return (@CR, (13)).		\| \r \|\| Match a carriage return (@CR, [[Chr]](13)).
	\|-		\|-
	\| \R \|\| a newline sequence.		\| \R \|\| a newline sequence.
	\|-		\|-
	\| \s \|\| Match any whitespace character: (9) through (13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( (32) ).		\| \s \|\| Match any whitespace character: [[Chr]](9) through [[Chr]](13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( [[Chr]](32) ).
	\|-		\|-
	\| \S \|\| Match any non-whitespace character.		\| \S \|\| Match any non-whitespace character.
	\|-		\|-
	\| \t \|\| Match a tab character ((9)).		\| \t \|\| Match a tab character ([[Chr]](9)).
	\|-		\|-
	\| \v \|\| any vertical whitespace character.		\| \v \|\| any vertical whitespace character.
Line 245:		Line 249:
	\| [:alpha:] \|\| letters (same as [A-Za-z])		\| [:alpha:] \|\| letters (same as [A-Za-z])
	\|-		\|-
	\| [:ascii:] \|\| character codes (same as (0) ... (127))		\| [:ascii:] \|\| character codes (same as [[Chr]](0) ... [[Chr]](127))
	\|-		\|-
	\| [:blank:] \|\| space or tab only (same as (9) and (32))		\| [:blank:] \|\| space or tab only (same as [[Chr]](9) and [[Chr]](32))
	\|-		\|-
	\| [:cntrl:] \|\| control characters (same as (0) ... (31) and (127))		\| [:cntrl:] \|\| control characters (same as [[Chr]](0) ... [[Chr]](31) and [[Chr]](127))
	\|-		\|-
	\| [:digit:] \|\| decimal digits (same as \d or [0-9])		\| [:digit:] \|\| decimal digits (same as \d or [0-9])
	\|-		\|-
	\| [:graph:] \|\| printing characters, excluding space (same as (33) ... (126))		\| [:graph:] \|\| printing characters, excluding space (same as [[Chr]](33) ... [[Chr]](126))
	\|-		\|-
	\| [:lower:] \|\| lower case letters (same as [a-z])		\| [:lower:] \|\| lower case letters (same as [a-z])
	\|-		\|-
	\| [:print:] \|\| printing characters, including space (same as (32) ... (126))		\| [:print:] \|\| printing characters, including space (same as [[Chr]](32) ... [[Chr]](126))
	\|-		\|-
	\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)		\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)
	\|-		\|-
	\| [:space:] \|\| white space (not quite the same as \s, it includes VT: (11)) (same as [\f\n\r\t\v ])		\| [:space:] \|\| white space (not quite the same as \s, it includes VT: [[Chr]](11)) (same as [\f\n\r\t\v ])
	\|-		\|-
	\| [:upper:] \|\| upper case letters (same as [A-Z])		\| [:upper:] \|\| upper case letters (same as [A-Z])
Line 288:		Line 292:
	8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.		8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.

	See also the tutorial, in which you can run a script to test your regular expression(s).		See also the [http://www.autoitscript.com/autoit3/docs/tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).



	<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>		===<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[StringInStr]], [[StringRegExpReplace]]		[[StringInStr]], [[StringRegExpReplace]]



	<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>		===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
	<syntaxhighlight lang='autoit'>		<syntaxhighlight lang='autoit'>
	#include <MsgBoxConstants.au3>		#include <MsgBoxConstants.au3>
Line 344:		Line 348:
	</font>		</font>
	__NOTOC__		__NOTOC__
			__NOEDITSECTION__

Jaberwocky6669 at 03:14, 21 August 2013

2013-08-21T03:14:59Z

← Older revision		Revision as of 03:14, 21 August 2013
Line 1:		Line 1:
	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
	<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>		<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

	<font size='3' weight='normal'>Check if a string fits a given regular expression pattern.</font>		<font size='3' weight='normal'>Check if a string fits a given regular expression pattern.</font>

	<div id='Syntax' style='background-color:#FFFFAA;'~~>:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )</div~~>		<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>


			:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )

	<font size='4'><div id='Section' style='color:#DB7100;'>Parameters</div></font>
			</div></font>



			<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>
	{\| class='wikitable'		{\| class='wikitable'
	\|-		\|-
Line 36:		Line 42:


	<font size='4'><div id='Section' style='color:#DB7100;'>Return Value</div></font>		<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>
	''Flag = 0 :''		''Flag = 0 :''

Line 76:		Line 82:


	<font size='4'><div id='Section' style='color:#DB7100;'>Remarks</div></font>		<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>
	The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.		The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.

Line 87:		Line 93:
	Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.		Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.

	Complete description can be found '''~~[[here]]~~'''		Complete description can be found ''''''

	'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.		'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.
Line 137:		Line 143:
	\| \\ \|\| Match an actual backslash (\).		\| \\ \|\| Match an actual backslash (\).
	\|-		\|-
	\| \a \|\| Alarm, that is, the BEL character (~~[[Chr]]~~(7)).		\| \a \|\| Alarm, that is, the BEL character ((7)).
	\|-		\|-
	\| \A \|\| Match only at beginning of string.		\| \A \|\| Match only at beginning of string.
Line 151:		Line 157:
	\| \D \|\| Match any non-digit.		\| \D \|\| Match any non-digit.
	\|-		\|-
	\| \e \|\| Match an escape character (~~[[Chr]]~~(27)).		\| \e \|\| Match an escape character ((27)).
	\|-		\|-
	\| \E \|\| end case modification.		\| \E \|\| end case modification.
	\|-		\|-
	\| \f \|\| Match an formfeed character (~~[[Chr]]~~(12)).		\| \f \|\| Match an formfeed character ((12)).
	\|-		\|-
	\| \G \|\| first matching position in subject.		\| \G \|\| first matching position in subject.
Line 163:		Line 169:
	\| \H \|\| any character that is not a horizontal whitespace character.		\| \H \|\| any character that is not a horizontal whitespace character.
	\|-		\|-
	\| \n \|\| Match a linefeed (@LF, ~~[[Chr]]~~(10)).		\| \n \|\| Match a linefeed (@LF, (10)).
	\|-		\|-
	\| \K \|\| reset start of match.		\| \K \|\| reset start of match.
Line 171:		Line 177:
	\| \Q \|\| quote (disable) pattern metacharacters till \E.		\| \Q \|\| quote (disable) pattern metacharacters till \E.
	\|-		\|-
	\| \r \|\| Match a carriage return (@CR, ~~[[Chr]]~~(13)).		\| \r \|\| Match a carriage return (@CR, (13)).
	\|-		\|-
	\| \R \|\| a newline sequence.		\| \R \|\| a newline sequence.
	\|-		\|-
	\| \s \|\| Match any whitespace character: ~~[[Chr]]~~(9) through ~~[[Chr]]~~(13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( ~~[[Chr]]~~(32) ).		\| \s \|\| Match any whitespace character: (9) through (13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( (32) ).
	\|-		\|-
	\| \S \|\| Match any non-whitespace character.		\| \S \|\| Match any non-whitespace character.
	\|-		\|-
	\| \t \|\| Match a tab character (~~[[Chr]]~~(9)).		\| \t \|\| Match a tab character ((9)).
	\|-		\|-
	\| \v \|\| any vertical whitespace character.		\| \v \|\| any vertical whitespace character.
Line 239:		Line 245:
	\| [:alpha:] \|\| letters (same as [A-Za-z])		\| [:alpha:] \|\| letters (same as [A-Za-z])
	\|-		\|-
	\| [:ascii:] \|\| character codes (same as ~~[[Chr]]~~(0) ... ~~[[Chr]]~~(127))		\| [:ascii:] \|\| character codes (same as (0) ... (127))
	\|-		\|-
	\| [:blank:] \|\| space or tab only (same as ~~[[Chr]]~~(9) and ~~[[Chr]]~~(32))		\| [:blank:] \|\| space or tab only (same as (9) and (32))
	\|-		\|-
	\| [:cntrl:] \|\| control characters (same as ~~[[Chr]]~~(0) ... ~~[[Chr]]~~(31) and ~~[[Chr]]~~(127))		\| [:cntrl:] \|\| control characters (same as (0) ... (31) and (127))
	\|-		\|-
	\| [:digit:] \|\| decimal digits (same as \d or [0-9])		\| [:digit:] \|\| decimal digits (same as \d or [0-9])
	\|-		\|-
	\| [:graph:] \|\| printing characters, excluding space (same as ~~[[Chr]]~~(33) ... ~~[[Chr]]~~(126))		\| [:graph:] \|\| printing characters, excluding space (same as (33) ... (126))
	\|-		\|-
	\| [:lower:] \|\| lower case letters (same as [a-z])		\| [:lower:] \|\| lower case letters (same as [a-z])
	\|-		\|-
	\| [:print:] \|\| printing characters, including space (same as ~~[[Chr]]~~(32) ... ~~[[Chr]]~~(126))		\| [:print:] \|\| printing characters, including space (same as (32) ... (126))
	\|-		\|-
	\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)		\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)
	\|-		\|-
	\| [:space:] \|\| white space (not quite the same as \s, it includes VT: ~~[[Chr]]~~(11)) (same as [\f\n\r\t\v ])		\| [:space:] \|\| white space (not quite the same as \s, it includes VT: (11)) (same as [\f\n\r\t\v ])
	\|-		\|-
	\| [:upper:] \|\| upper case letters (same as [A-Z])		\| [:upper:] \|\| upper case letters (same as [A-Z])
Line 282:		Line 288:
	8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.		8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.

	See also the ~~[[Regular Expression]]~~ tutorial, in which you can run a script to test your regular expression(s).		See also the tutorial, in which you can run a script to test your regular expression(s).



	<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>		<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>
	[[StringInStr]], [[StringRegExpReplace]]		[[StringInStr]], [[StringRegExpReplace]]



	<font size='4'><div id='Section' style='color:#DB7100;'>Example</div></font>		<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>
	<syntaxhighlight lang='autoit'>		<syntaxhighlight lang='autoit'>
	#include <MsgBoxConstants.au3>		#include <MsgBoxConstants.au3>

Jaberwocky6669 at 05:00, 20 August 2013

2013-08-20T05:00:39Z

Show changes

Jaberwocky6669 at 17:31, 19 August 2013

2013-08-19T17:31:26Z

← Older revision		Revision as of 17:31, 19 August 2013
Line 1:		Line 1:
	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->

	<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>		<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>

	===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===
	<font size='3' weight='normal'>		<font size='3' weight='normal'>

Jaberwocky6669 at 17:31, 19 August 2013

2013-08-19T17:31:01Z

← Older revision		Revision as of 17:31, 19 August 2013
Line 1:		Line 1:
			<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->

	<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>		<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>

	~~<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->~~

	===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===
Line 11:		Line 11:
	:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )		:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )
	</div>		</div>


	===<font size='4'><div id='Section' style='color:#DB7100;'>Parameters</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
Line 24:		Line 23:
	\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.		\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.
	\|}		\|}


	{\| class='wikitable'		{\| class='wikitable'
Line 40:		Line 38:
	\| 4 \|\| Return an array of arrays containing global matches including the full match (Perl / PHP style).		\| 4 \|\| Return an array of arrays containing global matches including the full match (Perl / PHP style).
	\|}		\|}


	===<font size='4'><div id='Section' style='color:#DB7100;'>Return Value</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
Line 51:		Line 48:
	\| 2 \|\| Bad pattern. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern. @extended = offset of error in pattern.
	\|}		\|}


	''Flag = 1 or 2 :''		''Flag = 1 or 2 :''
Line 65:		Line 61:
	\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.
	\|}		\|}


	''Flag = 3 or 4 :''		''Flag = 3 or 4 :''
Line 79:		Line 74:
	\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.
	\|}		\|}


	===<font size='4'><div id='Section' style='color:#DB7100;'>Remarks</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
Line 288:		Line 282:

	See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).		See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).


	===<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[StringInStr]], [[StringRegExpReplace]]		[[StringInStr]], [[StringRegExpReplace]]


	===<font size='4'><div id='Section' style='color:#DB7100;'>Example</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Example</div></font>===

Jaberwocky6669 at 17:27, 19 August 2013

2013-08-19T17:27:40Z

← Older revision		Revision as of 17:27, 19 August 2013
Line 2:		Line 2:

	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->


	===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===

Jaberwocky6669 at 17:25, 19 August 2013

2013-08-19T17:25:35Z

← Older revision		Revision as of 17:25, 19 August 2013
Line 1:		Line 1:
			<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>

	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
	~~<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>~~

	===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===
Line 10:		Line 12:
	:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )		:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )
	</div>		</div>





Line 26:		Line 25:
	\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.		\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.
	\|}		\|}



Line 43:		Line 41:
	\| 4 \|\| Return an array of arrays containing global matches including the full match (Perl / PHP style).		\| 4 \|\| Return an array of arrays containing global matches including the full match (Perl / PHP style).
	\|}		\|}



Line 55:		Line 52:
	\| 2 \|\| Bad pattern. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern. @extended = offset of error in pattern.
	\|}		\|}




Line 71:		Line 66:
	\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.
	\|}		\|}




Line 87:		Line 80:
	\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.
	\|}		\|}




Line 298:		Line 289:

	See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).		See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).




	===<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>===		===<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[StringInStr]], [[StringRegExpReplace]]		[[StringInStr]], [[StringRegExpReplace]]

Jaberwocky6669: Looks similar to the helpfile.

2013-08-19T17:14:00Z

Looks similar to the helpfile.

← Older revision		Revision as of 17:14, 19 August 2013
Line 1:		Line 1:
	<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->		<!-- Autogenerated Wiki Page. See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
	==Description==		<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>

			===<font size='4'><div id='Section' style='color:#DB7100;'>Description</div></font>===
			<font size='3' weight='normal'>
	Check if a string fits a given regular expression pattern.		Check if a string fits a given regular expression pattern.
			</font>

			<div id='Syntax' style='background-color:#FFFFAA;'>
			:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )
			</div>


	~~<code>~~
	~~StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )~~
	~~</code>~~

	==Parameters==

			===<font size='4'><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
	{\| class='wikitable'		{\| class='wikitable'
	\|-		\|-
Line 18:		Line 26:
	\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.		\| offset \|\| '''[optional]''' The string position to start the match (starts at 1) The default is 1.
	\|}		\|}



	{\| class='wikitable'		{\| class='wikitable'
Line 34:		Line 44:
	\|}		\|}

	==Return Value==

			===<font size='4'><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
	''Flag = 0 :''		''Flag = 0 :''

Line 43:		Line 55:
	\| 2 \|\| Bad pattern. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern. @extended = offset of error in pattern.
	\|}		\|}




	''Flag = 1 or 2 :''		''Flag = 1 or 2 :''
Line 56:		Line 71:
	\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern, array is invalid. @extended = offset of error in pattern.
	\|}		\|}




	''Flag = 3 or 4 :''		''Flag = 3 or 4 :''
Line 70:		Line 88:
	\|}		\|}

	==Remarks==


			===<font size='4'><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
	The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.		The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.

Line 278:		Line 299:
	See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).		See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).

	==Related==


			===<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[StringInStr]], [[StringRegExpReplace]]		[[StringInStr]], [[StringRegExpReplace]]

	==Example==


			===<font size='4'><div id='Section' style='color:#DB7100;'>Example</div></font>===
	<syntaxhighlight lang='autoit'>		<syntaxhighlight lang='autoit'>
	#include <MsgBoxConstants.au3>		#include <MsgBoxConstants.au3>
Line 326:		Line 353:
	Next		Next
	</syntaxhighlight>		</syntaxhighlight>

			</font>

	__NOTOC__		__NOTOC__

Jaberwocky6669 at 15:08, 19 August 2013

2013-08-19T15:08:43Z

← Older revision		Revision as of 15:08, 19 August 2013
Line 38:		Line 38:

	{\| class='wikitable'		{\| class='wikitable'
	\| @error \|\| Meaning		! \| @error:
			! \| Meaning
	\|-		\|-
	\| 2 \|\| Bad pattern. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern. @extended = offset of error in pattern.
Line 46:		Line 47:

	{\| class='wikitable'		{\| class='wikitable'
	\| @error \|\| Meaning		! \| @error:
			! \| Meaning
	\|-		\|-
	\| 0 \|\| Array is valid. Check @extended for next offset		\| 0 \|\| Array is valid. Check @extended for next offset
Line 58:		Line 60:

	{\| class='wikitable'		{\| class='wikitable'
	\| @error \|\| Meaning		! \| @error:
			! \| Meaning
	\|-		\|-
	\| 0 \|\| Array is valid.		\| 0 \|\| Array is valid.
Line 273:		Line 276:
	8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.		8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.

	See also the ~~<a href="~~../tutorials/regexp/regexp.htm">Regular Expression~~</a>~~ tutorial, in which you can run a script to test your regular expression(s).		See also the [../tutorials/regexp/regexp.htm Regular Expression] tutorial, in which you can run a script to test your regular expression(s).

	==Related==		==Related==

Jaberwocky6669 at 14:21, 19 August 2013

2013-08-19T14:21:55Z

← Older revision		Revision as of 14:21, 19 August 2013
Line 37:		Line 37:
	''Flag = 0 :''		''Flag = 0 :''

	{\|		{\| class='wikitable'
	! \| @error:		\| @error \|\| Meaning
	! \| Meaning
	\|-		\|-
	\| 2 \|\| Bad pattern. @extended = offset of error in pattern.		\| 2 \|\| Bad pattern. @extended = offset of error in pattern.
Line 46:		Line 45:
	''Flag = 1 or 2 :''		''Flag = 1 or 2 :''

	{\|		{\| class='wikitable'
	! \| @error:		\| @error \|\| Meaning
	! \| Meaning
	\|-		\|-
	\| 0 \|\| Array is valid. Check @extended for next offset		\| 0 \|\| Array is valid. Check @extended for next offset
Line 59:		Line 57:
	''Flag = 3 or 4 :''		''Flag = 3 or 4 :''

	{\|		{\| class='wikitable'
	! \| @error:		\| @error \|\| Meaning
	! \| Meaning
	\|-		\|-
	\| 0 \|\| Array is valid.		\| 0 \|\| Array is valid.
Line 131:		Line 128:
	\| \\ \|\| Match an actual backslash (\).		\| \\ \|\| Match an actual backslash (\).
	\|-		\|-
	\| \a \|\| Alarm, that is, the BEL character ([Chr](7)).		\| \a \|\| Alarm, that is, the BEL character ([[Chr]](7)).
	\|-		\|-
	\| \A \|\| Match only at beginning of string.		\| \A \|\| Match only at beginning of string.
Line 145:		Line 142:
	\| \D \|\| Match any non-digit.		\| \D \|\| Match any non-digit.
	\|-		\|-
	\| \e \|\| Match an escape character ([Chr](27)).		\| \e \|\| Match an escape character ([[Chr]](27)).
	\|-		\|-
	\| \E \|\| end case modification.		\| \E \|\| end case modification.
	\|-		\|-
	\| \f \|\| Match an formfeed character ([Chr](12)).		\| \f \|\| Match an formfeed character ([[Chr]](12)).
	\|-		\|-
	\| \G \|\| first matching position in subject.		\| \G \|\| first matching position in subject.
Line 157:		Line 154:
	\| \H \|\| any character that is not a horizontal whitespace character.		\| \H \|\| any character that is not a horizontal whitespace character.
	\|-		\|-
	\| \n \|\| Match a linefeed (@LF, [Chr](10)).		\| \n \|\| Match a linefeed (@LF, [[Chr]](10)).
	\|-		\|-
	\| \K \|\| reset start of match.		\| \K \|\| reset start of match.
Line 165:		Line 162:
	\| \Q \|\| quote (disable) pattern metacharacters till \E.		\| \Q \|\| quote (disable) pattern metacharacters till \E.
	\|-		\|-
	\| \r \|\| Match a carriage return (@CR, [Chr](13)).		\| \r \|\| Match a carriage return (@CR, [[Chr]](13)).
	\|-		\|-
	\| \R \|\| a newline sequence.		\| \R \|\| a newline sequence.
	\|-		\|-
	\| \s \|\| Match any whitespace character: [Chr](9) through [Chr](13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( [Chr](32) ).		\| \s \|\| Match any whitespace character: [[Chr]](9) through [[Chr]](13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( [[Chr]](32) ).
	\|-		\|-
	\| \S \|\| Match any non-whitespace character.		\| \S \|\| Match any non-whitespace character.
	\|-		\|-
	\| \t \|\| Match a tab character ([Chr](9)).		\| \t \|\| Match a tab character ([[Chr]](9)).
	\|-		\|-
	\| \v \|\| any vertical whitespace character.		\| \v \|\| any vertical whitespace character.
Line 233:		Line 230:
	\| [:alpha:] \|\| letters (same as [A-Za-z])		\| [:alpha:] \|\| letters (same as [A-Za-z])
	\|-		\|-
	\| [:ascii:] \|\| character codes (same as [Chr](0) ... [Chr](127))		\| [:ascii:] \|\| character codes (same as [[Chr]](0) ... [[Chr]](127))
	\|-		\|-
	\| [:blank:] \|\| space or tab only (same as [Chr](9) and [Chr](32))		\| [:blank:] \|\| space or tab only (same as [[Chr]](9) and [[Chr]](32))
	\|-		\|-
	\| [:cntrl:] \|\| control characters (same as [Chr](0) ... [Chr](31) and [Chr](127))		\| [:cntrl:] \|\| control characters (same as [[Chr]](0) ... [[Chr]](31) and [[Chr]](127))
	\|-		\|-
	\| [:digit:] \|\| decimal digits (same as \d or [0-9])		\| [:digit:] \|\| decimal digits (same as \d or [0-9])
	\|-		\|-
	\| [:graph:] \|\| printing characters, excluding space (same as [Chr](33) ... [Chr](126))		\| [:graph:] \|\| printing characters, excluding space (same as [[Chr]](33) ... [[Chr]](126))
	\|-		\|-
	\| [:lower:] \|\| lower case letters (same as [a-z])		\| [:lower:] \|\| lower case letters (same as [a-z])
	\|-		\|-
	\| [:print:] \|\| printing characters, including space (same as [Chr](32) ... [Chr](126))		\| [:print:] \|\| printing characters, including space (same as [[Chr]](32) ... [[Chr]](126))
	\|-		\|-
	\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)		\| [:punct:] \|\| printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)
	\|-		\|-
	\| [:space:] \|\| white space (not quite the same as \s, it includes VT: [Chr](11)) (same as [\f\n\r\t\v ])		\| [:space:] \|\| white space (not quite the same as \s, it includes VT: [[Chr]](11)) (same as [\f\n\r\t\v ])
	\|-		\|-
	\| [:upper:] \|\| upper case letters (same as [A-Z])		\| [:upper:] \|\| upper case letters (same as [A-Z])
Line 279:		Line 276:

	==Related==		==Related==
	[StringInStr], [StringRegExpReplace]		[[StringInStr]], [[StringRegExpReplace]]

	==Example==		==Example==