RunspaceFactory.CreateRunspacePool Method (Int32, Int32, RunspaceConnectionInfo, PSHost)

Creates a runspace pool that contains runspaces that can be opened on a remote computer. The runspace pool specifies the minimum number of runspaces that Windows PowerShell maintains open, the maximum number of runspaces in the pool, a custom host, and the connection information used to connect to a computer. This method is introduced in Windows PowerShell 2.0.


Namespace: System.Management.Automation.Runspaces
Assembly: System.Management.Automation (in System.Management.Automation.dll)

'Usage
Dim minRunspaces As Integer
Dim maxRunspaces As Integer
Dim connectionInfo As RunspaceConnectionInfo
Dim host As PSHost
Dim returnValue As RunspacePool

returnValue = RunspaceFactory.CreateRunspacePool(minRunspaces, maxRunspaces, connectionInfo, host)

[SuppressMessageAttribute("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId="Runspaces")] 
public static RunspacePool CreateRunspacePool (
	int minRunspaces,
	int maxRunspaces,
	RunspaceConnectionInfo connectionInfo,
	PSHost host
)
/** @attribute SuppressMessageAttribute("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId="Runspaces") */ 
public static RunspacePool CreateRunspacePool (
	int minRunspaces, 
	int maxRunspaces, 
	RunspaceConnectionInfo connectionInfo, 
	PSHost host
)
SuppressMessageAttribute("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId="Runspaces") 
public static function CreateRunspacePool (
	minRunspaces : int, 
	maxRunspaces : int, 
	connectionInfo : RunspaceConnectionInfo, 
	host : PSHost
) : RunspacePool

Parameters

minRunspaces

The minimum number of opened runspaces that Windows PowerShell maintains open even if the runspaces are no longer needed (default is one). Typically, Windows PowerShell destroys opened runspaces when they are no longer needed.

maxRunspaces

The maximum number of runspaces that are allowed to be open. Set to a value greater than the minRunspaces parameter.

connectionInfo

An object that derives from the RunspaceConnectionInfo abstract class. This object defines the information used to connect to a specific computer.

host

A PSHost object that represents the host. A host is needed to interact or communicate directly with the user through prompting.

Return Value

Returns a RunspacePool object that represents the pool with the maximum number of runspaces, the minimum number of runspaces maintained open, and the specified connection information and custom host used when a runspace from the pool is open.

A runspace pool is a set of runspaces that have the same features, such as the same host, initial session state, and connection information. A runspace from the pool is the operating environment used when invoking the commands of a pipeline. After the runspace pool is created, a runspace from the pool must be opened by using one of the following methods before it can be used:

  • To open a runspace from the pool synchronously, call the Open method.

  • To open a runspace from the pool asynchronously, call the BeginOpen method.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms


Show:
© 2014 Microsoft