GetProcessSample03 サンプル

2025-03-25

このサンプルでは、ローカルコンピューター上のプロセスを取得するコマンドレットを実装する方法を示します。パイプラインからオブジェクトを受け取ることができる Name パラメーター、またはプロパティ名がパラメーター名と同じオブジェクトのプロパティの値を受け取ることができます。このコマンドレットは、Windows PowerShell 2.0 によって提供される Get-Process コマンドレットの簡略化されたバージョンです。

Visual Studio を使用してサンプルをビルドする方法

Windows PowerShell 2.0 SDK がインストールされたら、GetProcessSample03 フォルダーに移動します。既定の場所は C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\GetProcessSample03です。
ソリューション (.sln) ファイルのアイコンをダブルクリックします。 Visual Studio でサンプルプロジェクトが開きます。
[ビルド] メニューの [ソリューションのビルド] を選択して、既定の \bin フォルダーまたは \bin\debug フォルダーにサンプルのライブラリをビルドします。

サンプルを実行する方法

次のモジュールフォルダーを作成します。

[user]\Documents\WindowsPowerShell\Modules\GetProcessSample03
サンプルアセンブリをモジュールフォルダーにコピーします。
Windows PowerShell を起動します。
次のコマンドを実行して、アセンブリを Windows PowerShell に読み込みます。

Import-Module getprossessample03
次のコマンドを実行してコマンドレットを実行します。

Get-Proc

必要条件

このサンプルには、Windows PowerShell 2.0 が必要です。

対象

このサンプルでは、次の例を示します。

コマンドレット属性を使用してコマンドレットクラスを宣言する。
Parameter 属性を使用してコマンドレットパラメーターを宣言する。
パラメーターの位置を指定します。
パラメーターがパイプラインから入力を受け取っていることを指定します。入力は、パラメーター名と同じプロパティ名を持つオブジェクトのプロパティから、オブジェクトまたは値から取得できます。
パラメーター入力の検証属性の宣言。

例

このサンプルでは、パイプラインからの入力を受け入れる Name パラメーターを含む Get-Proc コマンドレットの実装を示します。

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
}

こちらもご覧ください

Windows PowerShell コマンドレットの作成