Parancsmagkészletek

A parancsmagok tervezésekor előfordulhatnak olyan esetek, amikor több műveletet kell végrehajtania ugyanazon az adatrészen. Előfordulhat például, hogy be kell szereznie és be kell állítania az adatokat, vagy el kell indítania és le kell állítania egy folyamatot. Bár minden művelet végrehajtásához külön parancsmagokat kell létrehoznia, a parancsmagtervnek tartalmaznia kell egy alaposztályt, amelyből az egyes parancsmagok osztályai származnak.

Az alaposztály megvalósításakor tartsa szem előtt az alábbi szempontokat.

• Deklarálja az alaposztály összes származtatott parancsmagja által használt gyakori paramétereket.

• Adjon hozzá parancsmagspecifikus paramétereket a megfelelő parancsmagosztályhoz.

• Felülbírálja a megfelelő bemeneti feldolgozási módszert az alaposztályban.

• Deklarálja a System.Management.Automation.CmdletAttribute attribútumot az összes parancsmagosztályon, de ne deklarálja az alaposztályon.

• Implementáljon egy System.Management.Automation.PSSnapIn vagy System.Management.Automation.CustomPSSnapIn osztályt, amelynek neve és leírása a parancsmagok készletét tükrözi.

Példa

Az alábbi példa egy olyan alaposztály implementálását mutatja be, amelyet Get-Proc és Stop-Proc parancsmag használ, amely ugyanabból az alaposztályból származik.

using System;
using System.Diagnostics;
using System.Management.Automation;             //Windows PowerShell namespace.

namespace Microsoft.Samples.PowerShell.Commands
{

  #region ProcessCommands

  /// <summary>
  /// This class implements a Stop-Proc cmdlet. The parameters
  /// for this cmdlet are defined by the BaseProcCommand class.
  /// </summary>
  [Cmdlet(VerbsLifecycle.Stop, "Proc", SupportsShouldProcess = true)]
  public class StopProcCommand : BaseProcCommand
  {
    public override void ProcessObject(Process process)
    {
      if (ShouldProcess(process.ProcessName, "Stop-Proc"))
      {
        process.Kill();
      }
    }
  }

  /// <summary>
  /// This class implements a Get-Proc cmdlet. The parameters
  /// for this cmdlet are defined by the BaseProcCommand class.
  /// </summary>

  [Cmdlet(VerbsCommon.Get, "Proc")]
  public class GetProcCommand : BaseProcCommand
  {
    public override void ProcessObject(Process process)
    {
      WriteObject(process);
    }
  }

  /// <summary>
  /// This class is the base class that defines the common
  /// functionality used by the Get-Proc and Stop-Proc
  /// cmdlets.
  /// </summary>
  public class BaseProcCommand : Cmdlet
  {
    #region Parameters

    // Defines the Name parameter that is used to
    // specify a process by its name.
    [Parameter(
               Position = 0,
               Mandatory = true,
               ValueFromPipeline = true,
               ValueFromPipelineByPropertyName = true
    )]
    public string[] Name
    {
      get { return processNames; }
      set { processNames = value; }
    }
    private string[] processNames;

    // Defines the Exclude parameter that is used to
    // specify which processes should be excluded when
    // the cmdlet performs its action.
    [Parameter()]
    public string[] Exclude
    {
      get { return excludeNames; }
      set { excludeNames = value; }
    }
    private string[] excludeNames = new string[0];
    #endregion Parameters

    public virtual void ProcessObject(Process process)
    {
      throw new NotImplementedException("This method should be overridden.");
    }

    #region Cmdlet Overrides
    // <summary>
    // For each of the requested process names, retrieve and write
    // the associated processes.
    // </summary>
    protected override void ProcessRecord()
    {
      // Set up the wildcard characters used in resolving
      // the process names.
      WildcardOptions options = WildcardOptions.IgnoreCase |
                                WildcardOptions.Compiled;

      WildcardPattern[] include = new WildcardPattern[Name.Length];
      for (int i = 0; i < Name.Length; i++)
      {
        include[i] = new WildcardPattern(Name[i], options);
      }

      WildcardPattern[] exclude = new WildcardPattern[Exclude.Length];
      for (int i = 0; i < Exclude.Length; i++)
      {
        exclude[i] = new WildcardPattern(Exclude[i], options);
      }

      foreach (Process p in Process.GetProcesses())
      {
        foreach (WildcardPattern wIn in include)
        {
          if (wIn.IsMatch(p.ProcessName))
          {
            bool processThisOne = true;
            foreach (WildcardPattern wOut in exclude)
            {
              if (wOut.IsMatch(p.ProcessName))
              {
                processThisOne = false;
                break;
              }
            }
            if (processThisOne)
            {
              ProcessObject(p);
            }
            break;
          }
        }
      }
    }
    #endregion Cmdlet Overrides
  }
    #endregion ProcessCommands
}

Lásd még:

Windows PowerShell-parancsmag írása