/
ArgumentExtensions.xml
430 lines (430 loc) · 30.1 KB
/
ArgumentExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
<Type Name="ArgumentExtensions" FullName="System.CommandLine.ArgumentExtensions">
<TypeSignature Language="C#" Value="public static class ArgumentExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ArgumentExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.CommandLine.ArgumentExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ArgumentExtensions" />
<TypeSignature Language="F#" Value="type ArgumentExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ArgumentExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides extension methods for <see cref="T:System.CommandLine.Argument" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddCompletions<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument AddCompletions<TArgument> (this TArgument argument, System.CommandLine.Completions.CompletionDelegate complete) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument AddCompletions<(class System.CommandLine.Argument) TArgument>(!!TArgument argument, class System.CommandLine.Completions.CompletionDelegate complete) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.AddCompletions``1(``0,System.CommandLine.Completions.CompletionDelegate)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, complete As CompletionDelegate) As TArgument" />
<MemberSignature Language="F#" Value="static member AddCompletions : 'Argument * System.CommandLine.Completions.CompletionDelegate -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.AddCompletions (argument, complete)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument AddCompletions(TArgument argument, System::CommandLine::Completions::CompletionDelegate ^ complete);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
<Parameter Name="complete" Type="System.CommandLine.Completions.CompletionDelegate" />
</Parameters>
<Docs>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="argument">The argument for which to add completions.</param>
<param name="complete">A <see cref="T:System.CommandLine.Completions.CompletionDelegate" /> that will be called to provide completions.</param>
<summary>
Adds completions for an argument.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddCompletions<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument AddCompletions<TArgument> (this TArgument argument, Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<string>> complete) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument AddCompletions<(class System.CommandLine.Argument) TArgument>(!!TArgument argument, class System.Func`2<class System.CommandLine.Completions.CompletionContext, class System.Collections.Generic.IEnumerable`1<string>> complete) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.AddCompletions``1(``0,System.Func{System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable{System.String}})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, complete As Func(Of CompletionContext, IEnumerable(Of String))) As TArgument" />
<MemberSignature Language="F#" Value="static member AddCompletions : 'Argument * Func<System.CommandLine.Completions.CompletionContext, seq<string>> -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.AddCompletions (argument, complete)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument AddCompletions(TArgument argument, Func<System::CommandLine::Completions::CompletionContext ^, System::Collections::Generic::IEnumerable<System::String ^> ^> ^ complete);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
<Parameter Name="complete" Type="System.Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<System.String>>" />
</Parameters>
<Docs>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="argument">The argument for which to add completions.</param>
<param name="complete">A <see cref="T:System.CommandLine.Completions.CompletionDelegate" /> that will be called to provide completions.</param>
<summary>
Adds completions for an option.
</summary>
<returns>The option being extended.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddCompletions<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument AddCompletions<TArgument> (this TArgument argument, params string[] values) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument AddCompletions<(class System.CommandLine.Argument) TArgument>(!!TArgument argument, string[] values) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.AddCompletions``1(``0,System.String[])" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, ParamArray values As String()) As TArgument" />
<MemberSignature Language="F#" Value="static member AddCompletions : 'Argument * string[] -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.AddCompletions (argument, values)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument AddCompletions(TArgument argument, ... cli::array <System::String ^> ^ values);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
<Parameter Name="values" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="argument">The argument for which to add completions.</param>
<param name="values">The completions to add.</param>
<summary>
Adds completions for an argument.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExistingOnly">
<MemberSignature Language="C#" Value="public static System.CommandLine.Argument<System.IO.DirectoryInfo> ExistingOnly (this System.CommandLine.Argument<System.IO.DirectoryInfo> argument);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Argument`1<class System.IO.DirectoryInfo> ExistingOnly(class System.CommandLine.Argument`1<class System.IO.DirectoryInfo> argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.ExistingOnly(System.CommandLine.Argument{System.IO.DirectoryInfo})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ExistingOnly (argument As Argument(Of DirectoryInfo)) As Argument(Of DirectoryInfo)" />
<MemberSignature Language="F#" Value="static member ExistingOnly : System.CommandLine.Argument<System.IO.DirectoryInfo> -> System.CommandLine.Argument<System.IO.DirectoryInfo>" Usage="System.CommandLine.ArgumentExtensions.ExistingOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Argument<System::IO::DirectoryInfo ^> ^ ExistingOnly(System::CommandLine::Argument<System::IO::DirectoryInfo ^> ^ argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument<System.IO.DirectoryInfo></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument<System.IO.DirectoryInfo>" RefType="this" />
</Parameters>
<Docs>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values corresponding to an existing directory.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExistingOnly">
<MemberSignature Language="C#" Value="public static System.CommandLine.Argument<System.IO.FileInfo> ExistingOnly (this System.CommandLine.Argument<System.IO.FileInfo> argument);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Argument`1<class System.IO.FileInfo> ExistingOnly(class System.CommandLine.Argument`1<class System.IO.FileInfo> argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.ExistingOnly(System.CommandLine.Argument{System.IO.FileInfo})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ExistingOnly (argument As Argument(Of FileInfo)) As Argument(Of FileInfo)" />
<MemberSignature Language="F#" Value="static member ExistingOnly : System.CommandLine.Argument<System.IO.FileInfo> -> System.CommandLine.Argument<System.IO.FileInfo>" Usage="System.CommandLine.ArgumentExtensions.ExistingOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Argument<System::IO::FileInfo ^> ^ ExistingOnly(System::CommandLine::Argument<System::IO::FileInfo ^> ^ argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument<System.IO.FileInfo></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument<System.IO.FileInfo>" RefType="this" />
</Parameters>
<Docs>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values corresponding to an existing file.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExistingOnly">
<MemberSignature Language="C#" Value="public static System.CommandLine.Argument<System.IO.FileSystemInfo> ExistingOnly (this System.CommandLine.Argument<System.IO.FileSystemInfo> argument);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Argument`1<class System.IO.FileSystemInfo> ExistingOnly(class System.CommandLine.Argument`1<class System.IO.FileSystemInfo> argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.ExistingOnly(System.CommandLine.Argument{System.IO.FileSystemInfo})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ExistingOnly (argument As Argument(Of FileSystemInfo)) As Argument(Of FileSystemInfo)" />
<MemberSignature Language="F#" Value="static member ExistingOnly : System.CommandLine.Argument<System.IO.FileSystemInfo> -> System.CommandLine.Argument<System.IO.FileSystemInfo>" Usage="System.CommandLine.ArgumentExtensions.ExistingOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Argument<System::IO::FileSystemInfo ^> ^ ExistingOnly(System::CommandLine::Argument<System::IO::FileSystemInfo ^> ^ argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument<System.IO.FileSystemInfo></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument<System.IO.FileSystemInfo>" RefType="this" />
</Parameters>
<Docs>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values corresponding to an existing file or directory.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExistingOnly<T>">
<MemberSignature Language="C#" Value="public static System.CommandLine.Argument<T> ExistingOnly<T> (this System.CommandLine.Argument<T> argument) where T : System.Collections.Generic.IEnumerable<System.IO.FileSystemInfo>;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Argument`1<!!T> ExistingOnly<(class System.Collections.Generic.IEnumerable`1<class System.IO.FileSystemInfo>) T>(class System.CommandLine.Argument`1<!!T> argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.ExistingOnly``1(System.CommandLine.Argument{``0})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ExistingOnly(Of T As IEnumerable(Of FileSystemInfo)) (argument As Argument(Of T)) As Argument(Of T)" />
<MemberSignature Language="F#" Value="static member ExistingOnly : System.CommandLine.Argument<#seq<System.IO.FileSystemInfo>> -> System.CommandLine.Argument<#seq<System.IO.FileSystemInfo>>" Usage="System.CommandLine.ArgumentExtensions.ExistingOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 where T : System::Collections::Generic::IEnumerable<System::IO::FileSystemInfo ^>[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Argument<T> ^ ExistingOnly(System::CommandLine::Argument<T> ^ argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>System.Collections.Generic.IEnumerable<System.IO.FileSystemInfo></InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument<T>" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values corresponding to a existing files or directories.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromAmong<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument FromAmong<TArgument> (this TArgument argument, params string[] values) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument FromAmong<(class System.CommandLine.Argument) TArgument>(!!TArgument argument, string[] values) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.FromAmong``1(``0,System.String[])" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function FromAmong(Of TArgument As Argument) (argument As TArgument, ParamArray values As String()) As TArgument" />
<MemberSignature Language="F#" Value="static member FromAmong : 'Argument * string[] -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.FromAmong (argument, values)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument FromAmong(TArgument argument, ... cli::array <System::String ^> ^ values);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
<Parameter Name="values" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="argument">The argument to configure.</param>
<param name="values">The values that are allowed for the argument.</param>
<summary>
Configures an argument to accept only the specified values, and to suggest them as command line completions.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LegalFileNamesOnly<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument LegalFileNamesOnly<TArgument> (this TArgument argument) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument LegalFileNamesOnly<(class System.CommandLine.Argument) TArgument>(!!TArgument argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.LegalFileNamesOnly``1(``0)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function LegalFileNamesOnly(Of TArgument As Argument) (argument As TArgument) As TArgument" />
<MemberSignature Language="F#" Value="static member LegalFileNamesOnly : 'Argument -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.LegalFileNamesOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument LegalFileNamesOnly(TArgument argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
</Parameters>
<Docs>
<typeparam name="TArgument">To be added.</typeparam>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values representing legal file names.
</summary>
<returns>The configured argument.</returns>
<remarks>A parse error will result, for example, if file path separators are found in the parsed value.</remarks>
</Docs>
</Member>
<Member MemberName="LegalFilePathsOnly<TArgument>">
<MemberSignature Language="C#" Value="public static TArgument LegalFilePathsOnly<TArgument> (this TArgument argument) where TArgument : System.CommandLine.Argument;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TArgument LegalFilePathsOnly<(class System.CommandLine.Argument) TArgument>(!!TArgument argument) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.LegalFilePathsOnly``1(``0)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function LegalFilePathsOnly(Of TArgument As Argument) (argument As TArgument) As TArgument" />
<MemberSignature Language="F#" Value="static member LegalFilePathsOnly : 'Argument -> 'Argument (requires 'Argument :> System.CommandLine.Argument)" Usage="System.CommandLine.ArgumentExtensions.LegalFilePathsOnly argument" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TArgument>
 where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
 static TArgument LegalFilePathsOnly(TArgument argument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TArgument</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TArgument">
<Constraints>
<BaseTypeName>System.CommandLine.Argument</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="argument" Type="TArgument" RefType="this" />
</Parameters>
<Docs>
<typeparam name="TArgument">To be added.</typeparam>
<param name="argument">The argument to configure.</param>
<summary>
Configures an argument to accept only values representing legal file paths.
</summary>
<returns>The configured argument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static System.CommandLine.Parsing.ParseResult Parse (this System.CommandLine.Argument argument, string commandLine);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Parsing.ParseResult Parse(class System.CommandLine.Argument argument, string commandLine) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.Parse(System.CommandLine.Argument,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function Parse (argument As Argument, commandLine As String) As ParseResult" />
<MemberSignature Language="F#" Value="static member Parse : System.CommandLine.Argument * string -> System.CommandLine.Parsing.ParseResult" Usage="System.CommandLine.ArgumentExtensions.Parse (argument, commandLine)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Parsing::ParseResult ^ Parse(System::CommandLine::Argument ^ argument, System::String ^ commandLine);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Parsing.ParseResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument" RefType="this" />
<Parameter Name="commandLine" Type="System.String" />
</Parameters>
<Docs>
<param name="argument">The argument to use to parse the command line input.</param>
<param name="commandLine">A command line string to parse, which can include spaces and quotes equivalent to what can be entered into a terminal.</param>
<summary>
Parses a command line string value using an argument.
</summary>
<returns>A parse result describing the outcome of the parse operation.</returns>
<remarks>The command line string input will be split into tokens as if it had been passed on the command line.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static System.CommandLine.Parsing.ParseResult Parse (this System.CommandLine.Argument argument, string[] args);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.CommandLine.Parsing.ParseResult Parse(class System.CommandLine.Argument argument, string[] args) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.ArgumentExtensions.Parse(System.CommandLine.Argument,System.String[])" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function Parse (argument As Argument, args As String()) As ParseResult" />
<MemberSignature Language="F#" Value="static member Parse : System.CommandLine.Argument * string[] -> System.CommandLine.Parsing.ParseResult" Usage="System.CommandLine.ArgumentExtensions.Parse (argument, args)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Parsing::ParseResult ^ Parse(System::CommandLine::Argument ^ argument, cli::array <System::String ^> ^ args);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Parsing.ParseResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argument" Type="System.CommandLine.Argument" RefType="this" />
<Parameter Name="args" Type="System.String[]" />
</Parameters>
<Docs>
<param name="argument">The argument to use to parse the command line input.</param>
<param name="args">The string arguments to parse.</param>
<summary>
Parses a command line string value using an argument.
</summary>
<returns>A parse result describing the outcome of the parse operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>