PSJobProxy.RemoveJob Method

Definition

Namespace:

System.Management.Automation

Assembly:

System.Management.Automation.dll

Package:

Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Overloads

RemoveJob(Boolean)	Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved.
RemoveJob(Boolean, Boolean)	Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved.

RemoveJob(Boolean)

Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved.

public:
 void RemoveJob(bool removeRemoteJob);

public:
 void RemoveJob(bool removeRemoteJob);

void RemoveJob(bool removeRemoteJob);

public void RemoveJob (bool removeRemoteJob);

member this.RemoveJob : bool -> unit

Public Sub RemoveJob (removeRemoteJob As Boolean)

Parameters

removeRemoteJob

Boolean

Indicates whether the remove operation should be applied to the remote or local job.

Exceptions

InvalidOperationException

Thrown if the job is not in a completed state.

RemoveJob(Boolean, Boolean)

Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved.

public:
 void RemoveJob(bool removeRemoteJob, bool force);

public:
 void RemoveJob(bool removeRemoteJob, bool force);

void RemoveJob(bool removeRemoteJob, bool force);

public void RemoveJob (bool removeRemoteJob, bool force);

member this.RemoveJob : bool * bool -> unit

Public Sub RemoveJob (removeRemoteJob As Boolean, force As Boolean)

Parameters

removeRemoteJob

Boolean

Indicates whether the remove operation should be applied to the remote or local job.

force

Boolean

Force will stop the job on the server before attempting removal. Default value is false.

Exceptions

InvalidOperationException

Thrown if the job is not in a completed state.