Freigeben über


GetProcessSample03-Beispiel

In diesem Beispiel wird gezeigt, wie sie ein Cmdlet implementieren, das die Prozesse auf dem lokalen Computer abruft. Sie bietet einen Parameter, der ein Objekt aus der Pipeline oder einen Wert aus einer Eigenschaft eines Objekts akzeptieren kann, dessen Eigenschaftenname mit dem Name Parameternamen identisch ist. Dieses Cmdlet ist eine vereinfachte Version des Get-Process Cmdlets, das von Windows PowerShell 2.0 bereitgestellt wird.

Erstellen des Beispiels mithilfe Visual Studio.

  1. Wenn das Windows PowerShell 2.0 SDK installiert ist, navigieren Sie zum Ordner GetProcessSample03. Der Standardspeicherort ist C:\Programme (x86)\Microsoft SDKs\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\GetProcessSample03.

  2. Doppelklicken Sie auf das Symbol für die Projektmappendatei (SLN). Dadurch wird das Beispielprojekt in Visual Studio.

  3. Wählen Sie im Menü Erstellen die Option Projektmappe erstellen aus.

    Die Bibliothek für das Beispiel wird in den Standardordnern \bin oder \bin\debug erstellt.

Ausführen des Beispiels

  1. Erstellen Sie den folgenden Modulordner:

    [user]/documents/windowspowershell/modules/GetProcessSample03

  2. Kopieren Sie die Beispiel-Assembly in den Modulordner.

  3. Starten Sie Windows PowerShell.

  4. Führen Sie den folgenden Befehl aus, um die Assembly in Windows PowerShell:

    Import-module getprossessample03

  5. Führen Sie den folgenden Befehl aus, um das Cmdlet auszuführen:

    get-proc

Anforderungen

Dieses Beispiel erfordert Windows PowerShell 2.0.

Zeigt

In diesem Beispiel wird Folgendes veranschaulicht:

  • Deklarieren einer Cmdlet-Klasse mithilfe des Cmdlet-Attributs.

  • Deklarieren eines Cmdlet-Parameters mit dem Parameterattribut.

  • Angeben der Position des Parameters.

  • Geben Sie an, dass der Parameter Eingaben aus der Pipeline akzeptiert. Die Eingabe kann aus einem Objekt oder einem Wert aus einer Eigenschaft eines Objekts übernommen werden, dessen Eigenschaftenname mit dem Parameternamen identisch ist.

  • Deklarieren eines Validierungsattributs für die Parametereingabe.

Beispiel

Dieses Beispiel zeigt eine Implementierung des Cmdlets Get-Proc, das einen Parameter enthält, der Name Eingaben aus der Pipeline akzeptiert.

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 names of the
    /// process that the cmdlet will retrieve.
    /// </summary>
    [Parameter(
               Position = 0,
               ValueFromPipeline = true,
               ValueFromPipelineByPropertyName = true)]
    [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 processes 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 the cmdlet, get and write
        // the associated processes.
        foreach (string name in this.processNames)
        {
          WriteObject(Process.GetProcessesByName(name), true);
        }
      } // End if (processNames ...)
    } // End ProcessRecord.

    #endregion Overrides
  } // End GetProcCommand.
  #endregion GetProcCommand
}

Weitere Informationen

Schreiben eines Windows PowerShell-Cmdlets