GetProcessSample02 示例

此示例演示如何编写一个用于检索本地计算机上的进程的 cmdlet。 它提供一个 Name 参数,该参数可用于指定要检索的进程。 此 cmdlet 是 Get-Process Windows PowerShell 2.0 提供的 cmdlet 的简化版本。

如何使用 Visual Studio 生成示例。

  1. 安装 Windows PowerShell 2.0 SDK 后,导航到 GetProcessSample02 文件夹。 默认位置是 (x86) \microsoft sdk \ Windows \v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\GetProcessSample02. 的 C:\Program 文件。

  2. 双击解决方案的图标 ( .sln) 文件。 这会在 Visual Studio 中打开示例项目。

  3. 在“生成”菜单中选择“生成解决方案” 。

    示例库将在默认的 \bin 或 \bin\debug 文件夹中生成。

如何运行示例

  1. 创建以下模块文件夹:

    [user]/documents/windowspowershell/modules/GetProcessSample02

  2. 将示例程序集复制到模块文件夹中。

  3. 启动 Windows PowerShell。

  4. 运行以下命令,将程序集加载到 Windows PowerShell:

    import-module getprossessample02

  5. 运行以下命令以运行 cmdlet:

    get-proc

要求

此示例需要 Windows PowerShell 2.0。

演示

此示例演示以下各项。

  • 使用 Cmdlet 特性声明 cmdlet 类。

  • 使用参数属性声明 cmdlet 参数。

  • 指定参数的位置。

  • 声明参数输入的验证特性。

示例

此示例演示包含参数的 Get-Proc cmdlet 的实现 Name

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
}

另请参阅

编写 Windows PowerShell Cmdlet