Partager via

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

AddParameter(String)

Adds a switch parameter to the last added command. For example, to construct a command string "get-process | sort-object -descending"

PSCommand command = new PSCommand("get-process")
    .AddCommand("sort-object")
    .AddParameter("descending");
AddParameter(String, Object)

Add a parameter to the last added command. For example, to construct a command string "get-process | select-object -property name"

PSCommand command = new PSCommand("get-process")
    .AddCommand("select-object")
    .AddParameter("property", "name");

AddParameter(String)

Adds a switch parameter to the last added command. For example, to construct a command string "get-process | sort-object -descending"

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

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

Parameters

parameterName
String

Name of the parameter.

Returns

PSCommand

A PSCommand instance with parameterName added to the parameter list of the last command.

Exceptions

ArgumentException

Name is non null and name length is zero after trimming whitespace.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

Remarks

This method is not thread safe.

Applies to

AddParameter(String, Object)

Add a parameter to the last added command. For example, to construct a command string "get-process | select-object -property name"

PSCommand command = new PSCommand("get-process")
    .AddCommand("select-object")
    .AddParameter("property", "name");

public:
 System::Management::Automation::PSCommand ^ AddParameter(System::String ^ parameterName, System::Object ^ value);
public System.Management.Automation.PSCommand AddParameter (string parameterName, object value);
member this.AddParameter : string * obj -> System.Management.Automation.PSCommand
Public Function AddParameter (parameterName As String, value As Object) As PSCommand

Parameters

parameterName
String

Name of the parameter.

value
Object

Value for the parameter.

Returns

PSCommand

A PSCommand instance with parameterName added to the parameter list of the last command.

Exceptions

ArgumentException

Name is non null and name length is zero after trimming whitespace.

InvalidPowerShellStateException

Powershell instance cannot be changed in its current state.

Remarks

This method is not thread safe.

Applies to