ConsoleShell.Start Method

  • Reference

Definition

Namespace:
Microsoft.PowerShell
Assembly:
Microsoft.PowerShell.ConsoleHost.dll
Package:
Microsoft.PowerShell.ConsoleHost v7.0.13
Package:
Microsoft.PowerShell.ConsoleHost v7.1.7
Package:
Microsoft.PowerShell.ConsoleHost v7.2.12
Package:
Microsoft.PowerShell.ConsoleHost v7.3.5
Package:
Microsoft.PowerShell.ConsoleHost v7.4.0
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Overloads

Start(String, String, String[])

Entry point in to ConsoleShell. This method is called by main of minishell.
Start(InitialSessionState, String, String, String[])

Entry point in to ConsoleShell. Used to create a custom Powershell console application.
Start(RunspaceConfiguration, String, String, String[])

Entry point in to ConsoleShell. This method is called by main of minishell.

Start(String, String, String[])

Entry point in to ConsoleShell. This method is called by main of minishell.

public static int Start (string bannerText, string helpText, string[] args);
public static int Start (string? bannerText, string? helpText, string[] args);
[System.Runtime.CompilerServices.NullableContext(2)]
public static int Start (string? bannerText, string? helpText, string[] args);
static member Start : string * string * string[] -> int
[<System.Runtime.CompilerServices.NullableContext(2)>]
static member Start : string * string * string[] -> int
Public Shared Function Start (bannerText As String, helpText As String, args As String()) As Integer

Parameters

bannerText
String

Banner text to be displayed by ConsoleHost.

helpText
String

Help text for minishell. This is displayed on 'minishell -?'.

args
String[]

Commandline parameters specified by user.

Returns

Int32

An integer value which should be used as exit code for the process.

Attributes
NullableContextAttribute

Applies to

Start(InitialSessionState, String, String, String[])

Entry point in to ConsoleShell. Used to create a custom Powershell console application.

public static int Start (System.Management.Automation.Runspaces.InitialSessionState initialSessionState, string bannerText, string helpText, string[] args);
public static int Start (System.Management.Automation.Runspaces.InitialSessionState initialSessionState, string? bannerText, string? helpText, string[] args);
static member Start : System.Management.Automation.Runspaces.InitialSessionState * string * string * string[] -> int
Public Shared Function Start (initialSessionState As InitialSessionState, bannerText As String, helpText As String, args As String()) As Integer

Parameters

initialSessionState
InitialSessionState

InitialSessionState to be used by the ConsoleHost.

bannerText
String

Banner text to be displayed by ConsoleHost.

helpText
String

Help text for the shell.

args
String[]

Commandline parameters specified by user.

Returns

Int32

An integer value which should be used as exit code for the process.

Applies to

Start(RunspaceConfiguration, String, String, String[])

Entry point in to ConsoleShell. This method is called by main of minishell.

public:
 static int Start(System::Management::Automation::Runspaces::RunspaceConfiguration ^ configuration, System::String ^ bannerText, System::String ^ helpText, cli::array <System::String ^> ^ args);
public static int Start (System.Management.Automation.Runspaces.RunspaceConfiguration configuration, string bannerText, string helpText, string[] args);
static member Start : System.Management.Automation.Runspaces.RunspaceConfiguration * string * string * string[] -> int
Public Shared Function Start (configuration As RunspaceConfiguration, bannerText As String, helpText As String, args As String()) As Integer

Parameters

configuration
RunspaceConfiguration

Configuration information which is used to create Runspace.

bannerText
String

Banner text to be displayed by ConsoleHost

helpText
String

Help text for minishell. This is displayed on 'minishell -?'.

args
String[]

Commandline parameters specified by user.

Returns

Int32

An integer value which should be used as exit code for the process.

Applies to