Esempio di StopProcessSample01
Questo esempio illustra come scrivere un cmdlet che richiede feedback all'utente prima che tenti di arrestare un processo e come implementare un parametro che indica che l'utente vuole che il cmdlet restituirà PassThru un oggetto . Questo cmdlet è simile al Stop-Process cmdlet fornito da Windows PowerShell 2.0.
Come compilare l'esempio usando Visual Studio.
Con l Windows PowerShell SDK 2.0 installato, passare alla cartella StopProcessSample01. Il percorso predefinito è C:\Programmi (x86)\Microsoft SDK\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\StopProcessSample01.
Fare doppio clic sull'icona per il file di soluzione (sln). Verrà aperto il progetto di esempio in Microsoft Visual Studio.
Scegliere Compila soluzione dal menu Compila.
La libreria per l'esempio verrà compilata nelle cartelle \bin o \bin\debug predefinite.
Per eseguire l'esempio
Creare la cartella del modulo seguente:
[user]/documents/windowspowershell/modules/StopProcessSample01Copiare l'assembly di esempio nella cartella del modulo.
Avviare Windows PowerShell.
Eseguire il comando seguente per caricare l'assembly in Windows PowerShell:
import-module stopprossessample01Eseguire il comando seguente per eseguire il cmdlet :
stop-proc
Requisiti
Questo esempio richiede Windows PowerShell 2.0.
Dimostra
Questo esempio illustra quanto segue.
Dichiarazione di una classe di cmdlet tramite l'attributo Cmdlet.
Dichiarazione di parametri di un cmdlet tramite l'attributo Parameter.
Chiamata del metodo ShouldProcess per richiedere la conferma.
Implementazione di
PassThruun parametro che indica se l'utente vuole che il cmdlet restituirà un oggetto . Per impostazione predefinita, questo cmdlet non restituisce un oggetto alla pipeline.
Esempio
Questo esempio illustra come implementare un parametro che indica che l'utente vuole che il cmdlet restituirà un oggetto e come richiedere il feedback dell'utente tramite chiamate PassThru ai ShouldProcess metodi e ShouldContinue .
using System;
using System.Diagnostics;
using System.Collections;
using Win32Exception = System.ComponentModel.Win32Exception;
using System.Management.Automation; // Windows PowerShell namespace
using System.Globalization;
namespace Microsoft.Samples.PowerShell.Commands
{
#region StopProcCommand
/// <summary>
/// This class implements the stop-proc cmdlet.
/// </summary>
[Cmdlet(VerbsLifecycle.Stop, "Proc",
SupportsShouldProcess = true)]
public class StopProcCommand : Cmdlet
{
#region Parameters
/// <summary>
/// This parameter provides the list of process names on
/// which the Stop-Proc cmdlet will work.
/// </summary>
[Parameter(
Position = 0,
Mandatory = true,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true
)]
public string[] Name
{
get { return processNames; }
set { processNames = value; }
}
private string[] processNames;
/// <summary>
/// This parameter overrides the ShouldContinue call to force
/// the cmdlet to stop its operation. This parameter should always
/// be used with caution.
/// </summary>
[Parameter]
public SwitchParameter Force
{
get { return force; }
set { force = value; }
}
private bool force;
/// <summary>
/// This parameter indicates that the cmdlet should return
/// an object to the pipeline after the processing has been
/// completed.
/// </summary>
[Parameter]
public SwitchParameter PassThru
{
get { return passThru; }
set { passThru = value; }
}
private bool passThru;
#endregion Parameters
#region Cmdlet Overrides
/// <summary>
/// The ProcessRecord method does the following for each of the
/// requested process names:
/// 1) Check that the process is not a critical process.
/// 2) Attempt to stop that process.
/// If no process is requested then nothing occurs.
/// </summary>
protected override void ProcessRecord()
{
foreach (string name in processNames)
{
// For every process name passed to the cmdlet, get the associated
// processes.
// Write a nonterminating error for failure to retrieve
// a process.
Process[] processes;
try
{
processes = Process.GetProcessesByName(name);
}
catch (InvalidOperationException ioe)
{
WriteError(new ErrorRecord(ioe,"UnableToAccessProcessByName",
ErrorCategory.InvalidOperation, name));
continue;
}
// Try to stop the processes that have been retrieved.
foreach (Process process in processes)
{
string processName;
try
{
processName = process.ProcessName;
}
catch (Win32Exception e)
{
WriteError(new ErrorRecord(e, "ProcessNameNotFound",
ErrorCategory.ReadError, process));
continue;
}
// Confirm the operation with the user first.
// This is always false if the WhatIf parameter is set.
if (!ShouldProcess(string.Format(CultureInfo.CurrentCulture,"{0} ({1})", processName,
process.Id)))
{
continue;
}
// Make sure that the user really wants to stop a critical
// process that could possibly stop the computer.
bool criticalProcess =
criticalProcessNames.Contains(processName.ToLower(CultureInfo.CurrentCulture));
if (criticalProcess &&!force)
{
string message = String.Format
(CultureInfo.CurrentCulture,
"The process \"{0}\" is a critical process and should not be stopped. Are you sure you wish to stop the process?",
processName);
// It is possible that the ProcessRecord method is called
// multiple times when objects are received as inputs from
// the pipeline. So to retain YesToAll and NoToAll input that
// the user may enter across multiple calls to this function,
// they are stored as private members of the cmdlet.
if (!ShouldContinue(message, "Warning!",
ref yesToAll, ref noToAll))
{
continue;
}
} // if (criticalProcess...
// Stop the named process.
try
{
process.Kill();
}
catch (Exception e)
{
if ((e is Win32Exception) || (e is SystemException) ||
(e is InvalidOperationException))
{
// This process could not be stopped so write
// a nonterminating error.
WriteError(new ErrorRecord(e, "CouldNotStopProcess",
ErrorCategory.CloseError, process));
continue;
} // if ((e is...
else throw;
} // catch
// If the PassThru parameter is
// specified, return the terminated process.
if (passThru)
{
WriteObject(process);
}
} // foreach (Process...
} // foreach (string...
} // ProcessRecord
#endregion Cmdlet Overrides
#region Private Data
private bool yesToAll, noToAll;
/// <summary>
/// Partial list of critical processes that should not be
/// stopped. Lower case is used for case insensitive matching.
/// </summary>
private ArrayList criticalProcessNames = new ArrayList(
new string[] { "system", "winlogon", "spoolsv" }
);
#endregion Private Data
} // StopProcCommand
#endregion StopProcCommand
}