| description | Runspace05 Sample |
|---|---|
| ms.date | 09/13/2016 |
| ms.topic | reference |
| title | Runspace05 Sample |
This sample shows how to add a snap-in to a System.Management.Automation.Runspaces.InitialSessionState object so that the cmdlet of the snap-in is available when the runspace is opened. The snap-in provides a Get-Proc cmdlet (defined by the GetProcessSample01 Sample) that is run synchronously by using a System.Management.Automation.PowerShell object.
This sample requires Windows PowerShell 2.0.
This sample demonstrates the following.
-
Creating a System.Management.Automation.Runspaces.InitialSessionState object.
-
Adding the snap-in to the System.Management.Automation.Runspaces.InitialSessionState object.
-
Creating a System.Management.Automation.Runspaces.Runspace object that uses the System.Management.Automation.Runspaces.InitialSessionState object.
-
Creating a System.Management.Automation.PowerShell object that uses the runspace.
-
Adding the snap-in's Get-Proc cmdlet to the pipeline of the System.Management.Automation.PowerShell object.
-
Running the command synchronously.
-
Extracting properties from the System.Management.Automation.PSObject objects returned by the command.
This sample creates a runspace that uses a System.Management.Automation.Runspaces.InitialSessionState object to define the elements that are available when the runspace is opened. In this sample, a snap-in that defines a Get-Proc cmdlet is added to the initial session state.
namespace Microsoft.Samples.PowerShell.Runspaces
{
using System;
using System.Collections.ObjectModel;
using System.Management.Automation;
using System.Management.Automation.Runspaces;
using PowerShell = System.Management.Automation.PowerShell;
/// <summary>
/// This class contains the Main entry point for this host application.
/// </summary>
internal class Runspace05
{
/// <summary>
/// This sample shows how to define an initial session state that is
/// used when creating a runspace. The sample invokes a command from
/// a Windows PowerShell snap-in that is present in the console file.
/// </summary>
/// <param name="args">The parameter is not used.</param>
/// <remarks>
/// This sample assumes that user has copied the GetProcessSample01.dll
/// that is produced by the GetProcessSample01 sample to the current
/// directory.
/// This sample demonstrates the following:
/// 1. Creating a default initial session state.
/// 2. Adding a snap-in to the initial session state.
/// 3. Creating a runspace that uses the initial session state.
/// 4. Creating a PowerShell object that uses the runspace.
/// 5. Adding the snap-in's Get-Proc cmdlet to the PowerShell object.
/// 6. Using PSObject objects to extract and display properties from
/// the objects returned by the cmdlet.
/// </remarks>
private static void Main(string[] args)
{
// Create the default initial session state. The default initial
// session state contains all the elements provided by Windows
// PowerShell.
InitialSessionState iss = InitialSessionState.CreateDefault();
PSSnapInException warning;
iss.ImportPSSnapIn("GetProcPSSnapIn01", out warning);
// Create a runspace. Notice that no PSHost object is supplied to the
// CreateRunspace method so the default host is used. See the Host
// samples for more information on creating your own custom host.
using (Runspace myRunSpace = RunspaceFactory.CreateRunspace(iss))
{
myRunSpace.Open();
// Create a PowerShell object.
using (PowerShell powershell = PowerShell.Create())
{
// Add the snap-in cmdlet and specify the runspace.
powershell.AddCommand("GetProcPSSnapIn01\\Get-Proc");
powershell.Runspace = myRunSpace;
// Run the cmdlet synchronously.
Collection<PSObject> results = powershell.Invoke();
Console.WriteLine("Process HandleCount");
Console.WriteLine("--------------------------------");
// Display the results.
foreach (PSObject result in results)
{
Console.WriteLine(
"{0,-20} {1}",
result.Members["ProcessName"].Value,
result.Members["HandleCount"].Value);
}
}
// Close the runspace to release any resources.
myRunSpace.Close();
}
System.Console.WriteLine("Hit any key to exit...");
System.Console.ReadKey();
}
}
}