PSCommand.AddScript 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

AddScript(String)

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"

PSCommand command = new PSCommand("get-process")
    .AddScript("foreach { $_.Name }", true);
AddScript(String, Boolean)

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"

PSCommand command = new PSCommand("get-process")
    .AddScript("foreach { $_.Name }", true);

AddScript(String)

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"

PSCommand command = new PSCommand("get-process")
    .AddScript("foreach { $_.Name }", true);

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

Parameters

script
String

A string representing the script.

Returns

PSCommand

A PSCommand instance with script 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

AddScript(String, Boolean)

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"

PSCommand command = new PSCommand("get-process")
    .AddScript("foreach { $_.Name }", true);

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

Parameters

script
String

A string representing the script.

useLocalScope
Boolean

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

Returns

PSCommand

A PSCommand instance with script 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