Share via

SteppablePipeline.Begin 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

Begin(Boolean)

Begin execution of a steppable pipeline. This overload doesn't reroute output and error pipes.
Begin(InternalCommand)

Begin execution of a steppable pipeline, using the calling command to figure out how to route the output and errors. This is the most effective way to start stepping.
Begin(Boolean, EngineIntrinsics)

Begin execution of a steppable pipeline, using the command running currently in the specified context to figure out how to route the output and errors.

Begin(Boolean)

Begin execution of a steppable pipeline. This overload doesn't reroute output and error pipes.

public:
 void Begin(bool expectInput);
public:
 void Begin(bool expectInput);
void Begin(bool expectInput);
public void Begin (bool expectInput);
member this.Begin : bool -> unit
Public Sub Begin (expectInput As Boolean)

Parameters

expectInput
Boolean

true if you plan to write input into this pipe; false otherwise.

Applies to

Begin(InternalCommand)

Begin execution of a steppable pipeline, using the calling command to figure out how to route the output and errors. This is the most effective way to start stepping.

public:
 void Begin(System::Management::Automation::Internal::InternalCommand ^ command);
public void Begin (System.Management.Automation.Internal.InternalCommand command);
member this.Begin : System.Management.Automation.Internal.InternalCommand -> unit
Public Sub Begin (command As InternalCommand)

Parameters

command
InternalCommand

The command you're calling this from (i.e. instance of PSCmdlet or value of $PSCmdlet variable).

Applies to

Begin(Boolean, EngineIntrinsics)

Begin execution of a steppable pipeline, using the command running currently in the specified context to figure out how to route the output and errors.

public:
 void Begin(bool expectInput, System::Management::Automation::EngineIntrinsics ^ contextToRedirectTo);
public void Begin (bool expectInput, System.Management.Automation.EngineIntrinsics contextToRedirectTo);
member this.Begin : bool * System.Management.Automation.EngineIntrinsics -> unit
Public Sub Begin (expectInput As Boolean, contextToRedirectTo As EngineIntrinsics)

Parameters

expectInput
Boolean

true if you plan to write input into this pipe; false otherwise.

contextToRedirectTo
EngineIntrinsics

Context used to figure out how to route the output and errors.

Applies to