PowerShell.AddCommand Method

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Overloads

AddCommand(CommandInfo)

CommandInfo object for the command to add.
AddCommand(String)

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",

PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");
AddCommand(String, Boolean)

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",

PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");

AddCommand(CommandInfo)

CommandInfo object for the command to add.

public:
 System::Management::Automation::PowerShell ^ AddCommand(System::Management::Automation::CommandInfo ^ commandInfo);
public System.Management.Automation.PowerShell AddCommand (System.Management.Automation.CommandInfo commandInfo);
member this.AddCommand : System.Management.Automation.CommandInfo -> System.Management.Automation.PowerShell
Public Function AddCommand (commandInfo As CommandInfo) As PowerShell

Parameters

commandInfo
CommandInfo

The CommandInfo object for the command to add.

Returns

PowerShell

A PSCommand instance with the command added.

Exceptions

ArgumentNullException

command is null.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

ObjectDisposedException

Object is disposed.

Remarks

This method is not thread-safe.

Applies to

AddCommand(String)

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",

PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");

public:
 System::Management::Automation::PowerShell ^ AddCommand(System::String ^ cmdlet);
public System.Management.Automation.PowerShell AddCommand (string cmdlet);
member this.AddCommand : string -> System.Management.Automation.PowerShell
Public Function AddCommand (cmdlet As String) As PowerShell

Parameters

cmdlet
String

A string representing cmdlet.

Returns

PowerShell

A PowerShell instance with cmdlet added.

Exceptions

ArgumentNullException

cmdlet is null.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

ObjectDisposedException

Object is disposed.

Remarks

This method is not thread safe.

Applies to

AddCommand(String, Boolean)

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",

PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");

public:
 System::Management::Automation::PowerShell ^ AddCommand(System::String ^ cmdlet, bool useLocalScope);
public System.Management.Automation.PowerShell AddCommand (string cmdlet, bool useLocalScope);
member this.AddCommand : string * bool -> System.Management.Automation.PowerShell
Public Function AddCommand (cmdlet As String, useLocalScope As Boolean) As PowerShell

Parameters

cmdlet
String

A string representing cmdlet.

useLocalScope
Boolean

if true local scope is used to run the script command.

Returns

PowerShell

A PowerShell instance with cmdlet added.

Exceptions

ArgumentNullException

cmdlet is null.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

ObjectDisposedException

Object is disposed.

Remarks

This method is not thread safe.

Applies to