Voorbeeld GetProcessSample02

In dit voorbeeld ziet u hoe u een cmdlet schrijft die de processen op de lokale computer op haalt. Het biedt een Name parameter die kan worden gebruikt om de processen op te geven die moeten worden opgehaald. Deze cmdlet is een vereenvoudigde versie van de Get-Process cmdlet die wordt geleverd door Windows PowerShell 2.0.

Het voorbeeld bouwen met behulp van Visual Studio.

  1. Als de Windows PowerShell 2.0 SDK is geïnstalleerd, gaat u naar de map GetProcessSample02. De standaardlocatie is C:\Program Files (x86)\Microsoft SDK's\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\GetProcessSample02.

  2. Dubbelklik op het pictogram voor het oplossingsbestand (.sln). Hiermee opent u het voorbeeldproject in Visual Studio.

  3. Selecteer in het menu Bouwen de optie Oplossing bouwen.

    De bibliotheek voor het voorbeeld wordt gebouwd in de standaardmappen \bin of \bin\debug.

Het voorbeeld uitvoeren

  1. Maak de volgende modulemap:

    [user]/documents/windowspowershell/modules/GetProcessSample02

  2. Kopieer de voorbeeldassemblage naar de modulemap.

  3. Start Windows PowerShell.

  4. Voer de volgende opdracht uit om de assembly in de volgende Windows PowerShell:

    import-module getprossessample02

  5. Voer de volgende opdracht uit om de cmdlet uit te voeren:

    get-proc

Vereisten

Voor dit voorbeeld is Windows PowerShell 2.0 vereist.

Demonstreert

In dit voorbeeld wordt het volgende gedemonstreerd.

  • Een cmdlet-klasse declareren met behulp van het kenmerk Cmdlet.

  • Declareren van een cmdlet parameter met behulp van de Parameter kenmerk.

  • De positie van de parameter opgeven.

  • Het declareren van een validatiekenmerk voor de parameterinvoer.

Voorbeeld

In dit voorbeeld ziet u een implementatie van de Get-Proc cmdlet die een Name parameter bevat.

namespace Microsoft.Samples.PowerShell.Commands
{
  using System;
  using System.Diagnostics;
  using System.Management.Automation;     // Windows PowerShell namespace

  #region GetProcCommand

  /// <summary>
  /// This class implements the get-proc cmdlet.
  /// </summary>
  [Cmdlet(VerbsCommon.Get, "Proc")]
  public class GetProcCommand : Cmdlet
  {
    #region Parameters

    /// <summary>
    /// The names of the processes retrieved by the cmdlet.
    /// </summary>
    private string[] processNames;

    /// <summary>
    /// Gets or sets the list of process names on which
    /// the Get-Proc cmdlet will work.
    /// </summary>
    [Parameter(Position = 0)]
    [ValidateNotNullOrEmpty]
    public string[] Name
    {
      get { return this.processNames; }
      set { this.processNames = value; }
    }

    #endregion Parameters

    #region Cmdlet Overrides

    /// <summary>
    /// The ProcessRecord method calls the Process.GetProcesses
    /// method to retrieve the processes specified by the Name
    /// parameter. Then, the WriteObject method writes the
    /// associated process objects to the pipeline.
    /// </summary>
    protected override void ProcessRecord()
    {
      // If no process names are passed to the cmdlet, get all
      // processes.
      if (this.processNames == null)
      {
        WriteObject(Process.GetProcesses(), true);
      }
      else
      {
        // If process names are passed to cmdlet, get and write
        // the associated processes.
        foreach (string name in this.processNames)
        {
          WriteObject(Process.GetProcessesByName(name), true);
        }
      } // End if (processNames...).
    } // End ProcessRecord.
    #endregion Cmdlet Overrides
  } // End GetProcCommand class.
  #endregion GetProcCommand
}

Zie ook

Een Windows PowerShell-cmdlet schrijven