この例では、実行時にコマンドレットに追加される動的パラメーターを定義する方法を示します。 この例では、ユーザーが Employee
switch パラメーターを指定するたびに、Department
パラメーターがコマンドレットに追加されます。 動的パラメーターの詳細については、「コマンドレットの動的パラメーターの」を参照してください。
動的パラメーターを定義するには
コマンドレット クラス宣言で、次に示すように、System.Management.Automation.IDynamicParameters インターフェイスを追加します。
public class SendGreetingCommand : Cmdlet, IDynamicParameters
System.Management.Automation.IDynamicParameters.GetDynamicParameters* メソッドを呼び出します。このメソッドは、動的パラメーターが定義されているオブジェクトを返します。 この例では、
Employee
パラメーターが指定されたときにメソッドが呼び出されます。public object GetDynamicParameters() { if (employee) { context= new SendGreetingCommandDynamicParameters(); return context; } return null; } private SendGreetingCommandDynamicParameters context;
追加する動的パラメーターを定義するクラスを宣言します。 静的コマンドレット パラメーターを宣言するために使用した属性を使用して、動的パラメーターを宣言できます。
public class SendGreetingCommandDynamicParameters { [Parameter] [ValidateSet ("Marketing", "Sales", "Development")] public string Department { get { return department; } set { department = value; } } private string department; }
例
この例では、ユーザーが Employee
パラメーターを指定するたびに、Department
パラメーターが追加されます。
Department
パラメーターは省略可能なパラメーターであり、ValidateSet 属性を使用して許可される引数を指定します。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Management.Automation; // PowerShell assembly.
namespace SendGreeting
{
// Declare the cmdlet class that supports the
// IDynamicParameters interface.
[Cmdlet(VerbsCommunications.Send, "Greeting")]
public class SendGreetingCommand : Cmdlet, IDynamicParameters
{
// Declare the parameters for the cmdlet.
[Parameter(Mandatory = true)]
public string Name
{
get { return name; }
set { name = value; }
}
private string name;
[Parameter]
[Alias ("FTE")]
public SwitchParameter Employee
{
get { return employee; }
set { employee = value; }
}
private Boolean employee;
// Implement GetDynamicParameters to
// retrieve the dynamic parameter.
public object GetDynamicParameters()
{
if (employee)
{
context= new SendGreetingCommandDynamicParameters();
return context;
}
return null;
}
private SendGreetingCommandDynamicParameters context;
// Override the ProcessRecord method to process the
// supplied user name and write out a greeting to
// the user by calling the WriteObject method.
protected override void ProcessRecord()
{
WriteObject("Hello " + name + "! ");
if (employee)
{
WriteObject("Department: " + context.Department);
}
}
}
// Define the dynamic parameters to be added
public class SendGreetingCommandDynamicParameters
{
[Parameter]
[ValidateSet ("Marketing", "Sales", "Development")]
public string Department
{
get { return department; }
set { department = value; }
}
private string department;
}
}
こちらもご覧ください
PowerShell