nuget
A command line object that parse from the user input commandline string. (从用户所输入的命令行字符串之中解析出来的命令行对象，标准的命令行格式为： <EXE> <CLI_Name> ["Parameter" "Value"])
CommandLine
01 Syntax
Microsoft.VisualBasic.CommandLine.CommandLine
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| HavebFlag | 1 | See if the target logical flag argument is exists in the commandline? |
| ToString | 1 | Returns the original cli command line argument string. |
| GetFullDIRPath | 1 | Get specific argument value as full directory path. |
| GetFullFilePath | 1 | Get specific argument value as full file path. |
| CheckMissingRequiredParameters | 1 | Checking for the missing required parameter, this function will returns the missing parameter in the current cli command line object using a specific parameter name list. |
| CheckMissingRequiredArguments | 1 | Gets a list of missing required argument name. |
| ContainsParameter | 1 | Does the specific argument exists in this commandline? argument name is not case sensitity. |
| op_Implicit | 1 | Parsing the commandline string as object model |
| Assert | 1 | Determined that the specific Boolean flag is exists or not? if not then returns failure, if exists such flag, then returns the name. |
| GetDictionary | 1 | If the target parameter is not presents in the CLI, then this function will returns nothing. |
| IsTrue | 1 | Gets the value Of the specified column As a Boolean. |
| OpenStreamInput | 1 | About s: + If the file path is not a value path, then is the value is not null, the argument value will be returned from this parameter. |
| OpenStreamOutput | 1 | If the StreamWriter.BaseStream is FileStream, then it means not a std_out pointer. |
| ReadInput | 1 | Read all of the text input from the file or std_in |
| GetOrdinal | 1 | Return the index Of the named field. |
| GetString | 1 | Gets the String value Of the specified argument. |
| GetObject | 1 | |
| GetValue | 1 | If the given parameter is not exists in the user input arguments, then a developer specific default value will be return. |
| OpenHandle | 1 | Open a file handle by using the parameter value |
| GetEnumerator | 1 | 这个枚举函数也会将开关给包含进来，与CommandLine.ToArgumentVector()方法所不同的是，这个函数里面的逻辑值开关的名称没有被修饰剪裁 |
| Add | 2 | Adds an item to the System.Collections.Generic.ICollection1. |
| Clear | 1 | Clear the inner list buffer |
| Contains | 1 | 只是通过比较名称来判断是否存在，值没有进行比较 |
| Remove | 2 | Removes a parameter by NamedValue.Name |
| ToArgumentVector | 1 | 将当前的这个命令行对象之中的所有的参数值都合并到一个向量之中返回. |
| op_Addition | 1 | Open a handle for a file system object. |
| op_LessThanOrEqual | 1 | Gets the CLI parameter value. |
| op_Subtraction | 2 | Try get parameter value. |
| TrimNamePrefix | 1 | |
| Required | 1 | |
| GetObject | 1 | |
| GetValue | 1 | |
| GetEnumerator1 | 1 | |
| CopyTo | 1 | |
| CreateOpts | 1 | |
| op_Exponent | 1 | |
| op_GreaterThanOrEqual | 1 | |
| op_UnaryNegation | 1 | |
| op_GreaterThan | 1 | |
| op_LessThan | 1 | |
| Parse | 1 | |
| ParseTokens | 1 | |
| BuildFromArguments | 1 | |
| GetDataReader | 1 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| Name | 1 | The command name that parse from the input command line. |
| Tokens | 1 | The command tokens that were parsed from the input commandline. |
| ParameterList | 1 | Listing all of the parameter value collection that parsed from the commandline string. |
| Keys | 1 | 得到当前的命令行对象之中的所有的参数的名称的列表 |
| Parameters | 1 | The parameters in the commandline without the first token of the command name. |
| BoolFlags | 1 | 对于参数而言，都是--或者-或者/或者\开头的，下一个单词为单引号或者非上面的字符开头的，例如/o <path> 对于开关而言，与参数相同的其实符号，但是后面不跟参数而是其他的开关，通常开关用来进行简要表述一个逻辑值 |
| EnvironmentVariables | 1 | 获取得到通过/@set参数所传入的环境变量(键值对之间使用分号分隔) |
| cli | 1 | Get the original command line string. |
| Item | 1 | The parameter name is not case sensitive. |
| IsNullOrEmpty | 1 | Does this cli command line object contains any parameter argument information. |
| IsNothing | 1 | String of CommandLine.Name AndAlso CommandLine.IsNullOrEmpty |
| Count | 1 | Get the switch counts in this commandline object.(获取本命令行对象中的所定义的开关的数目) |
| SingleValue | 1 |
04 Fields
| Name | Overloads | Summary |
|---|---|---|
| cliCommandArgvs | 1 | 原始的命令行字符串 |
05 Members
HavebFlag(
String)See if the target logical flag argument is exists in the commandline?
Parameters
| Name | Type | Description |
|---|---|---|
name | String | - |
Returns
(查看命令行之中是否存在某一个逻辑开关)
ToString
Returns the original cli command line argument string.
Remarks
(返回所传入的命令行的原始字符串)
GetFullDIRPath(
String)Get specific argument value as full directory path.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | parameter name |
GetFullFilePath(
String)Get specific argument value as full file path.
Remarks
(这个函数还会同时修正file://协议的头部)
Parameters
| Name | Type | Description |
|---|---|---|
name | String | parameter name |
CheckMissingRequiredParameters(
IEnumerable(Of String))Checking for the missing required parameter, this function will returns the missing parameter in the current cli command line object using a specific parameter name list.
Remarks
(检查list之中的所有参数是否存在，函数会返回不存在的参数名)
Parameters
| Name | Type | Description |
|---|---|---|
list | IEnumerable(Of String) | - |
CheckMissingRequiredArguments(
String())Gets a list of missing required argument name.
Parameters
| Name | Type | Description |
|---|---|---|
args | String() | - |
ContainsParameter(
String, Boolean)Does the specific argument exists in this commandline? argument name is not case sensitity.
Remarks
(参数名称字符串大小写不敏感)
Parameters
| Name | Type | Description |
|---|---|---|
parameterName | String | - |
op_Implicit(
String)Parsing the commandline string as object model
Parameters
| Name | Type | Description |
|---|---|---|
CommandLine | String | - |
Assert(
String, String)Determined that the specific Boolean flag is exists or not? if not then returns failure, if exists such flag, then returns the name.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Boolean flag name |
failure | String | - |
GetDictionary(
String, String)If the target parameter is not presents in the CLI, then this function will returns nothing.
Remarks
(键值对之间使用分号分隔)
Parameters
| Name | Type | Description |
|---|---|---|
name | String | - |
IsTrue(
String)Gets the value Of the specified column As a Boolean.
Remarks
(这个函数也同时包含有开关参数的，开关参数默认为逻辑值类型，当包含有开关参数的时候，其逻辑值为True，反之函数会检查参数列表，参数不存在则为空值字符串，则也为False)
Parameters
| Name | Type | Description |
|---|---|---|
parameter | String | 可以包含有开关参数 |
OpenStreamInput(
String, String)About s:
- If the file path is not a value path, then is the value is not null, the argument value will be returned from this parameter.
- If the value is nothing, then this function will open the standard input as input.
- If the file path is valid as input file, then a local file system pointer will be returned.
[管道函数] 假若参数名存在并且所指向的文件也存在，则返回本地文件的文件指针，否则返回标准输入的指针
Parameters
| Name | Type | Description |
|---|---|---|
param | String | - |
s | String |
|
If the StreamWriter.BaseStream is FileStream, then it means not a std_out pointer. ([管道函数] 假若参数名存在，则返回本地文件的文件指针，否则返回标准输出的指针)
Parameters
| Name | Type | Description |
|---|---|---|
param | String | - |
ReadInput(
String)Read all of the text input from the file or std_in
Remarks
这个函数会首先尝试使用CommandLine.OpenStreamInput()打开本地文件和标准输出流 如果失败的话CommandLine.OpenStreamInput()函数会返回空值，这个时候参数字符串将会直接被 返回作为结果，如果打开成功的话，会将得到的输入流之中的所有字符串读出来返回
Parameters
| Name | Type | Description |
|---|---|---|
param | String | - |
GetOrdinal(
String)Return the index Of the named field. If the name is not exists in the parameter list, then a -1 value will be return.
GetString(
String)Gets the String value Of the specified argument.
GetObject``1(
String, Func(Of String, ``0))Type Parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
parameter | String | Command parameter name in the command line inputs. |
__getObject | Func(Of String, ``0) | - |
GetValue``1(
String, ``0, Func(Of String, ``0))If the given parameter is not exists in the user input arguments, then a developer specific default value will be return.
Type Parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The optional argument parameter name |
[default] | ``0 | The default value for returns when the parameter is not exists in the user input. |
cast | Func(Of String, ``0) | The custom string parser for the CLI argument value |
Open a file handle by using the parameter value
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The parameter name, and its argument value should be a valid file path |
[default] | String | Default file path if the argument value is not exists |
GetEnumerator
这个枚举函数也会将开关给包含进来，与CommandLine.ToArgumentVector()方法所不同的是，这个函数里面的逻辑值开关的名称没有被修饰剪裁
Adds an item to the System.Collections.Generic.ICollection`1.
Parameters
| Name | Type | Description |
|---|---|---|
item | NamedValue(Of String) | - |
Add(
String, String, Boolean, String)Add a parameter with name and its value.
Parameters
| Name | Type | Description |
|---|---|---|
key | String | - |
value | String | - |
Clear
Clear the inner list buffer
Contains(NamedValue(Of String))
只是通过比较名称来判断是否存在，值没有进行比较
Parameters
| Name | Type | Description |
|---|---|---|
item | NamedValue(Of String) | - |
Remove(
String)Removes a parameter by name
Parameters
| Name | Type | Description |
|---|---|---|
paramName | String | - |
Remove(NamedValue(Of String))
Removes a parameter by NamedValue.Name
Parameters
| Name | Type | Description |
|---|---|---|
item | NamedValue(Of String) | - |
ToArgumentVector
将当前的这个命令行对象之中的所有的参数值都合并到一个向量之中返回. (ToArray拓展好像是有BUG的，所以请使用这个函数来获取所有的参数信息。 请注意，逻辑值开关的名称会被去掉前缀)
Remarks
the description value in the populated vector is indicates the argument value type.
op_Addition(CommandLine,
String)Open a handle for a file system object.
Parameters
| Name | Type | Description |
|---|---|---|
args | CommandLine | - |
fs | String | - |
op_LessThanOrEqual(CommandLine,
String)Gets the CLI parameter value.
Parameters
| Name | Type | Description |
|---|---|---|
args | CommandLine | - |
name | String | - |
op_Subtraction(CommandLine,
String)Try get parameter value.
Parameters
| Name | Type | Description |
|---|---|---|
args | CommandLine | - |
name | String | - |
op_Subtraction(CommandLine, CommandLine)
Try get parameter value.
Parameters
| Name | Type | Description |
|---|---|---|
args | CommandLine | - |
Name
The command name that parse from the input command line.
Remarks
(从输入的命令行中所解析出来的命令的名称)
Tokens
The command tokens that were parsed from the input commandline.
Remarks
(从所输入的命令行之中所解析出来的命令参数单元)
ParameterList
Listing all of the parameter value collection that parsed from the commandline string.
Keys
得到当前的命令行对象之中的所有的参数的名称的列表
Parameters
The parameters in the commandline without the first token of the command name.
Remarks
(将命令行解析为词元之后去掉命令的名称之后所剩下的所有的字符串列表)
BoolFlags
对于参数而言，都是--或者-或者/或者\开头的，下一个单词为单引号或者非上面的字符开头的，例如/o <path> 对于开关而言，与参数相同的其实符号，但是后面不跟参数而是其他的开关，通常开关用来进行简要表述一个逻辑值
EnvironmentVariables
获取得到通过/@set参数所传入的环境变量(键值对之间使用分号分隔)
Returns
this readonly property ensure that the result dictionary is always not null, but may be empty.
cli
Get the original command line string.
Remarks
(获取所输入的命令行对象的原始的字符串)
Item(
String)The parameter name is not case sensitive.
Remarks
(开关的名称是不区分大小写的，进行字符串插值脚本化处理的时候，是使用的App.GetVariable()函数来获取环境变量值)
Parameters
| Name | Type | Description |
|---|---|---|
paramName | String | The argument name in the commandline. 2018-09-10为了兼容VB的!字典取值语法，这个属性是会自动处理开关参数的前缀的 即会自动的将开关参数的/--等前缀删除尝试进行取值 这个自动转换不会应用于逻辑开关参数上面 |
IsNullOrEmpty
Does this cli command line object contains any parameter argument information.
Remarks
(查看本命令行参数对象之中是否存在有参数信息)
IsNothing
String of CommandLine.Name AndAlso CommandLine.IsNullOrEmpty
Count
Get the switch counts in this commandline object.(获取本命令行对象中的所定义的开关的数目)
cliCommandArgvs
原始的命令行字符串
SingleValue
TrimNamePrefix(
String)Required(
String, String)GetObject(
String, Func(Of String, T))GetValue(
String, T, Func(Of String, T))GetEnumerator1()
CopyTo(NamedValue(Of String)(),
Int32)CreateOpts()
op_Exponent(CommandLine,
String)op_GreaterThanOrEqual(
String, CommandLine)op_UnaryNegation(CommandLine)
op_GreaterThan(CommandLine,
String)op_LessThan(CommandLine,
String)Parse(
String)ParseTokens(
String)BuildFromArguments(
String(), Boolean)GetDataReader()