ShellCommandRunShellCommand Method (Assembly, String, String, Int32, CreateShellCommandOptions)

public static int RunShellCommand(
	Assembly assembly,
	string? commandName,
	string[] args,
	int index,
	CreateShellCommandOptions options
)

Public Shared Function RunShellCommand ( 
	assembly As Assembly,
	commandName As String,
	args As String(),
	index As Integer,
	options As CreateShellCommandOptions
) As Integer

Dim assembly As [Assembly]
Dim commandName As String
Dim args As String()
Dim index As Integer
Dim options As CreateShellCommandOptions
Dim returnValue As Integer

returnValue = ShellCommand.RunShellCommand(assembly, 
	commandName, args, index, options)

public:
static int RunShellCommand(
	Assembly^ assembly, 
	String^ commandName, 
	array<String^>^ args, 
	int index, 
	CreateShellCommandOptions^ options
)

Parameters

assembly

Type: System.ReflectionAssembly
The assembly to search for the shell command.

commandName

Type: SystemString
The name of the command.

args

Type: SystemString
The arguments to the shell command.

index

Type: SystemInt32
The index in args at which to start parsing the arguments.

options

Type: Ookii.CommandLineCreateShellCommandOptions
The options to use.

Return Value

If the command could not be found, a list of possible commands is written to Out. If an error occurs parsing the command's arguments, the error message is written to Error, and the shell command's usage information is written to Out.

If the Out property or Error property is , output is written to a LineWrappingTextWriter for the standard output and error streams respectively, wrapping at the console's window width. When the console output is redirected to a file, Microsoft .Net will still report the console's actual window width, but on Mono the value of the WindowWidth property will be 0. In that case, the usage information will not be wrapped.

If the Out property is instance of the LineWrappingTextWriter class, this method indents additional lines for the usage syntax and argument descriptions according to the values specified by the CreateShellCommandOptions, unless the MaximumLineLength property is less than 30.

Reference