PSJob Members

Represents a background job that runs a pipeline that can contain a command or expression. The job is run asynchronously without interacting with the console.

The following tables list the members exposed by the PSJob type.

Protected Constructors

	Name	Description
	PSJob	Overloaded.

Top

Public Fields

	Name	Description
	StateChanged	Event fired when the status of the PSJob changes, such as when the job has completed in all runspaces or failed in any one namespace.

Top

Public Properties

	Name	Description
	ChildJobs	Gets the PSJob objects for each runspace where the job is run, plus the object that defines the job.
	Command	Gets the pipeline to be executed by the PSJob.
	Debug	Gets and sets the debug output of the PSJob.
	Error	Gets and sets the error output of the PSJob.
	Finished	Gets the wait handle that is set when the job is completed on all runspaces, or stopped or failed on one or more runspaces.
	HasMoreData	Gets a Boolean value that indicates whether the PSJob result has more data.
	InstanceId	Gets the instance identifier of the PSJob that is unique throughout all runspaces.
	JobStateInfo	Gets information about the status of the PSJob.
	Location
	Name	Gets and sets the name of the PSJob.
	Output	Gets and sets the output of the PSJob.
	Progress	Gets and sets the progress data of the PSJob.
	SessionId	Gets the identifier of the PSJob that is unique within a session.
	StatusMessage	Gets the success message for the PSJob.
	Verbose	Gets and sets the verbose output for the PSJob.
	Warning	Gets and sets the warning output for the PSJob.

Top

Public Methods

(see also Protected Methods)

	Name	Description
	Dispose	Overloaded. Disposes the current PSJob object, which frees all resource used by the object. The variants of this method can dispose the method with or without a Boolean value that indicates that the object is in the process of being disposed.
	Equals	Overloaded. (Inherited from Object)
	GetHashCode	(Inherited from Object)
	GetType	(Inherited from Object)
	ReferenceEquals	(Inherited from Object)
	StopJob	Stops the PSJob on all runspaces.
	ToString	(Inherited from Object)

Top

Protected Methods

	Name	Description
	AutoGenerateJobName
	Dispose	Overloaded.
	Finalize	(Inherited from Object)
	MemberwiseClone	(Inherited from Object)
	SetJobState	Sets the status of the PSJob, such as running, completed, or failed.

Top

See Also

Reference

PSJob Class
System.Management.Automation Namespace

Send comments about this topic to Microsoft.