11Show-RegEx
22----------
3+
4+
5+
6+
37### Synopsis
48Shows a Regular Expression and it's output.
59
10+
11+
612---
13+
14+
715### Description
816
917Displays Regular Expressions, with their match output.
1018
19+
20+
1121---
22+
23+
1224### Related Links
1325* [ Get-Regex] ( Get-Regex.md )
1426
@@ -18,14 +30,22 @@ Displays Regular Expressions, with their match output.
1830
1931
2032
33+
34+
2135---
36+
37+
2238### Examples
2339#### EXAMPLE 1
2440``` PowerShell
2541-Match abc123def456
2642```
2743
44+
45+
2846---
47+
48+
2949### Parameters
3050#### ** Pattern**
3151
@@ -42,7 +62,6 @@ The regular expression. If the pattern starts with a saved capture name, it wil
4262
4363
4464
45- ---
4665#### ** Match**
4766
4867One or more strings to match.
@@ -58,7 +77,6 @@ One or more strings to match.
5877
5978
6079
61- ---
6280#### ** Remove**
6381
6482If set, will remove the regular expression matches from the text.
@@ -74,7 +92,6 @@ If set, will remove the regular expression matches from the text.
7492
7593
7694
77- ---
7895#### ** Replace**
7996
8097If set, will replace the text with a replacement string.
@@ -92,7 +109,6 @@ https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-reg
92109
93110
94111
95- ---
96112#### ** Transform**
97113
98114If provided, will transform each match with a replacement string.
@@ -110,7 +126,6 @@ https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-reg
110126
111127
112128
113- ---
114129#### ** Option**
115130
116131The regular expression options, by default, MultiLine, IgnoreCase and IgnorePatternWhitespace
@@ -137,13 +152,12 @@ Valid Values:
137152
138153
139154
140- | Type | Required| Position| PipelineInput |
141- | ----------------| --------| --------| ---------------------|
142- | ` [RegexOptions] ` | false | 4 | true (ByPropertyName)|
155+ | Type | Required| Position| PipelineInput | Aliases |
156+ | ----------------| --------| --------| ---------------------| ------- |
157+ | ` [RegexOptions] ` | false | 4 | true (ByPropertyName)| Options |
143158
144159
145160
146- ---
147161#### ** CaseSensitive**
148162
149163Indicates that the cmdlet makes matches case-sensitive. By default, matches are not case-sensitive.
@@ -159,7 +173,6 @@ Indicates that the cmdlet makes matches case-sensitive. By default, matches are
159173
160174
161175
162- ---
163176#### ** Timeout**
164177
165178The match timeout. By default, one second.
@@ -175,16 +188,23 @@ The match timeout. By default, one second.
175188
176189
177190
191+
192+
178193---
194+
195+
179196### Outputs
180197* Irregular.RegEx.Output
181198
182199
183200
184201
202+
203+
185204---
205+
206+
186207### Syntax
187208``` PowerShell
188209Show-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>]
189210```
190- ---
0 commit comments