GetProcessSample04 サンプル

このサンプルでは、ローカル コンピューター上のプロセスを取得するコマンドレットを実装する方法を示します。 プロセスの取得中にエラーが発生した場合、終了しないエラーが生成されます。 このコマンドレットは、Windows PowerShell Get-Process 2.0 で提供されるコマンドレットの簡略化されたバージョンです。

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

1. Windows PowerShell 2.0 SDK がインストールされている場合は、GetProcessSample04 フォルダーに移動します。 既定の場所は C:\Program Files (x86)\Microsoft SDK\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\GetProcessSample04 です。

2. ソリューション (.sln) ファイルのアイコンをダブルクリックします。 これにより、サンプル プロジェクトが Visual Studio。

3. [ビルド] メニューで、 [ソリューションのビルド] を選択します。

   サンプルのライブラリは、既定の \bin フォルダーまたは \bin\debug フォルダーにビルドされます。

サンプルを実行する方法

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

   [user]/documents/windowspowershell/modules/GetProcessSample04

2. サンプル アセンブリをモジュール フォルダーにコピーします。

3. Windows PowerShell を起動します。

4. 次のコマンドを実行して、アセンブリを読み込Windows PowerShell。

   Import-module getprossessample04

5. 次のコマンドを実行してコマンドレットを実行します。

   get-proc

必要条件

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

対象

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

• コマンドレット属性を使用したコマンドレット クラスの宣言。

• Parameter 属性を使用したコマンドレット パラメーターの宣言。

• パラメーターの位置を指定する。

• パラメーターがパイプラインから入力を受け取る場合に指定します。 入力は、オブジェクトまたはプロパティ名がパラメーター名と同じオブジェクトのプロパティの値から取得できます。

• パラメーター入力の検証属性の宣言。

• 非確認エラーをトラップし、エラー ストリームにエラー メッセージを書き込みます。

例

このサンプルでは、不特定のエラーを処理し、エラー メッセージをエラー ストリームに書き込むコマンドレットを作成する方法を示します。

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 to act on.
       /// </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,
         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 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.
              // If a nonterminating error occurs while retrieving processes,
              // call the WriteError method to send an error record to the
              // error stream.
              foreach (string name in this.processNames)
              {
                  Process[] processes;

                  try
                  {
                      processes = Process.GetProcessesByName(name);
                  }
                  catch (InvalidOperationException ex)
                  {
                      WriteError(new ErrorRecord(
                         ex,
                         "UnableToAccessProcessByName",
                         ErrorCategory.InvalidOperation,
                         name));
                      continue;
                  }

                  WriteObject(processes, true);
              } // foreach (string name...
          } // else
      } // ProcessRecord

      #endregion Overrides
    } // End GetProcCommand class.

   #endregion GetProcCommand
}

参照

Writing a Windows PowerShell Cmdlet (Windows PowerShell コマンドレットの記述)