PSCommand.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(Command)

Add a Command element to the current command pipeline.
AddCommand(String)

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

PSCommand command = new PSCommand("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",

PSCommand command = new PSCommand("get-process").AddCommand("sort-object");

AddCommand(Command)

Add a Command element to the current command pipeline.

public:
 System::Management::Automation::PSCommand ^ AddCommand(System::Management::Automation::Runspaces::Command ^ command);
public System.Management.Automation.PSCommand AddCommand (System.Management.Automation.Runspaces.Command command);
member this.AddCommand : System.Management.Automation.Runspaces.Command -> System.Management.Automation.PSCommand
Public Function AddCommand (command As Command) As PSCommand

Parameters

command
Command

Command to add.

Returns

PSCommand

A PSCommand instance with command added.

Exceptions

ArgumentNullException

command is null.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

Remarks

This method is not thread-safe.

Applies to

AddCommand(String)

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

PSCommand command = new PSCommand("get-process").AddCommand("sort-object");

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

Parameters

command
String

A string representing the command.

Returns

PSCommand

A PSCommand instance with command added.

Exceptions

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

ArgumentNullException

cmdlet is null.

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",

PSCommand command = new PSCommand("get-process").AddCommand("sort-object");

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

Parameters

cmdlet
String

A string representing cmdlet.

useLocalScope
Boolean

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

Returns

PSCommand

A PSCommand instance with cmdlet added.

Exceptions

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

ArgumentNullException

cmdlet is null.

Remarks

This method is not thread safe.

Applies to