11Show-RegEx
22----------
33
4-
5-
6-
74### Synopsis
85Shows a Regular Expression and it's output.
96
10-
11-
127---
138
14-
159### Description
1610
1711Displays Regular Expressions, with their match output.
1812
19-
20-
2113---
2214
23-
2415### Related Links
2516* [ Get-Regex] ( Get-Regex.md )
2617
27-
28-
2918* [ Use-Regex] ( Use-Regex.md )
3019
31-
32-
33-
34-
3520---
3621
37-
3822### Examples
39- #### EXAMPLE 1
23+ > EXAMPLE 1
24+
4025``` PowerShell
4126-Match abc123def456
4227```
4328
44-
45-
4629---
4730
48-
4931### Parameters
5032#### ** Pattern**
51-
5233The regular expression. If the pattern starts with a saved capture name, it will use the saved pattern.
5334
54-
55-
56-
57-
58-
5935| Type | Required| Position| PipelineInput |
6036| ----------| --------| --------| ---------------------|
6137| ` [String] ` | true | 1 | true (ByPropertyName)|
6238
63-
64-
6539#### ** Match**
66-
6740One or more strings to match.
6841
69-
70-
71-
72-
73-
7442| Type | Required| Position| PipelineInput |
7543| ------------| --------| --------| ---------------------|
7644| ` [String[]] ` | false | 2 | true (ByPropertyName)|
7745
78-
79-
8046#### ** Remove**
81-
8247If set, will remove the regular expression matches from the text.
8348
84-
85-
86-
87-
88-
8949| Type | Required| Position| PipelineInput |
9050| ----------| --------| --------| ---------------------|
9151| ` [Switch] ` | false | named | true (ByPropertyName)|
9252
93-
94-
9553#### ** Replace**
96-
9754If set, will replace the text with a replacement string.
9855For more information about replacement strings, see:
9956https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-regular-expressions
10057
101-
102-
103-
104-
105-
10658| Type | Required| Position| PipelineInput |
10759| ----------| --------| --------| ---------------------|
10860| ` [String] ` | false | named | true (ByPropertyName)|
10961
110-
111-
11262#### ** Transform**
113-
11463If provided, will transform each match with a replacement string.
11564For more information about replacement strings, see:
11665https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-regular-expressions
11766
118-
119-
120-
121-
122-
12367| Type | Required| Position| PipelineInput |
12468| ----------| --------| --------| ---------------------|
12569| ` [String] ` | false | named | true (ByPropertyName)|
12670
127-
128-
12971#### ** Option**
130-
13172The regular expression options, by default, MultiLine, IgnoreCase and IgnorePatternWhitespace
13273|Default Multiline,IgnoreCase,IgnorePatternWhitespace
13374|Multiselect
134-
135-
136-
13775Valid Values:
13876
13977* None
@@ -146,65 +84,34 @@ Valid Values:
14684* RightToLeft
14785* ECMAScript
14886* CultureInvariant
149-
150-
151-
152-
153-
87+ * NonBacktracking
15488
15589| Type | Required| Position| PipelineInput | Aliases|
15690| ----------------| --------| --------| ---------------------| -------|
15791| ` [RegexOptions] ` | false | 4 | true (ByPropertyName)| Options|
15892
159-
160-
16193#### ** CaseSensitive**
162-
16394Indicates that the cmdlet makes matches case-sensitive. By default, matches are not case-sensitive.
16495
165-
166-
167-
168-
169-
17096| Type | Required| Position| PipelineInput |
17197| ----------| --------| --------| ---------------------|
17298| ` [Switch] ` | false | named | true (ByPropertyName)|
17399
174-
175-
176100#### ** Timeout**
177-
178101The match timeout. By default, one second.
179102
180-
181-
182-
183-
184-
185103| Type | Required| Position| PipelineInput |
186104| ------------| --------| --------| ---------------------|
187105| ` [TimeSpan] ` | false | named | true (ByPropertyName)|
188106
189-
190-
191-
192-
193107---
194108
195-
196109### Outputs
197110* Irregular.RegEx.Output
198111
199-
200-
201-
202-
203-
204112---
205113
206-
207114### Syntax
208115``` PowerShell
209- Show-RegEx [-Pattern] <String> [[-Match] <String[]>] [-Remove] [-Replace <String>] [-Transform <String>] [[-Option] {None | IgnoreCase | Multiline | ExplicitCapture | Compiled | Singleline | IgnorePatternWhitespace | RightToLeft | ECMAScript | CultureInvariant}] [-CaseSensitive] [-Timeout <TimeSpan>] [<CommonParameters>]
116+ Show-RegEx [-Pattern] <String> [[-Match] <String[]>] [-Remove] [-Replace <String>] [-Transform <String>] [[-Option] {None | IgnoreCase | Multiline | ExplicitCapture | Compiled | Singleline | IgnorePatternWhitespace | RightToLeft | ECMAScript | CultureInvariant | NonBacktracking }] [-CaseSensitive] [-Timeout <TimeSpan>] [<CommonParameters>]
210117```
0 commit comments