参考

というか、そのまんま＾＾； 向こうのページがいつまであるか分からないので、保険のために。

• コマンドレットの作成方法 (C#と諸々)

RunspaceIvokeを使う

引数が数字とか文字列とかコマンドラインに記述し易い場合は、こちらの方が値の渡しが楽です。

1. RunspaceConfigurationのインスタンスAを作成する
2. A.Scripts.Append()で関数を定義する
3. Aを引数にRunspaceInvokeインスタンスBを作成する
4. B.Invokeメソッドで関数を呼ぶ
5. 返値をFor Eachなどで取り出す

関数を呼ぶ際はRunspaceInvokeインスタンスを作成後、Invokeメソッドに"関数名 引数1 引数2 ..."と引数込みの文字列を付けて呼び出します。 よってこの方法を使う場合、引数を文字列内に記述できないといけません。 Visual Studio側で作成したオブジェクトを渡したい場合は、次のパイプラインを使用することになります。

サンプルコード

Dim runspaceConfig As RunspaceConfiguration = RunspaceConfiguration.Create()

Dim scripts As RunspaceConfigurationEntryCollection(Of ScriptConfigurationEntry) = runspaceConfig.Scripts
scripts.Append(New ScriptConfigurationEntry("add", "param([double]$a,[double]$b);$a+$b"))

Dim runspaceInvoke As New RunspaceInvoke(runspaceConfig)
Dim results As ObjectModel.Collection(Of PSObject) = runspaceInvoke.Invoke("add 1 8")

For Each result As PSObject In results
  Console.WriteLine(result.ImmediateBaseObject.ToString)
Next

パイプラインを使う

引数の引渡しのために、呼び出し側・関数側双方で手数が増えますが、文字列では表現できないオブジェクトを渡せるという代え難い機能が使えます。

1. RunspaceConfigurationのインスタンスAを作成する
2. A.Scripts.Appendで関数を定義する
3. Aを引数にRunspaceFactory.CreateRunspace()でRunspaceインスタンスBを作成する
4. B.Open()を呼ぶ
5. B.CreatePipeline()でPipelineインスタンスCを作成する
6. C.Commands.Add()で呼び出す関数を記述する
7. C.Input.Write()で引き渡したいオブジェクトを登録する
8. C.Invoke()を呼ぶ
9. 返値をFor Eachなどで取り出す
10. B.Close()を呼ぶ

引数は特殊変数$inputの中に収められるので関数はここから値を得ます。中身はEnumlatorなのでforeachなどで取り出します。 引数を全部足すとかいう関数ならいいのですが、そうでなければforeachでどういう順番に値が取り出せるのか気になるところ。 C.Input.Write()でオブジェクトを入れた順番だと思います・・・多分^^； 万全を期すなら、

• 一回呼び出し分の引数はObject配列でひとまとめにしてInput.Writeメソッド一回で渡す
• 引数を渡す専用のクラスを定義する

になるでしょうか。何でもかんでもクラスとして定義する.NET Frameworkのやり方や、他のCmdletとの連携を考えるとクラスを定義したほうがよさそうです。

ここではCommands.Addでひとつの関数を呼び出してますが、もちろん|で複数のCmdletなどを繋いでもかまいません。これはRunspaceInvokeを使う場合でも同じです。

最後の結果を取り出すところは、RunspaceInvokeを使う場合と同じです。

サンプルコード

Dim runspaceConfig As RunspaceConfiguration = RunspaceConfiguration.Create()

Dim scripts As RunspaceConfigurationEntryCollection(Of ScriptConfigurationEntry) = runspaceConfig.Scripts
scripts.Append(New ScriptConfigurationEntry("add", "$a=0;foreach($b in $input){$a=$a+$b};$a"))

Dim runspace As Runspace = RunspaceFactory.CreateRunspace(runspaceConfig)
runspace.Open()

Dim rsPipeline As Pipeline = runspace.CreatePipeline()
rsPipeline.Commands.Add("add")
rsPipeline.Input.Write(1.0)
rsPipeline.Input.Write(8.0)

Dim results As ObjectModel.Collection(Of PSObject) = rsPipeline.Invoke

For Each result As PSObject In results
  Console.WriteLine(result.ImmediateBaseObject.ToString)
Next

関数の引数定義方法

PowerShellでは関数の宣言の書式として、

1. func1($a,$b){$a+$b}
2. func1{param($a,$b);$a+$b}
3. func1{$args[0]+$args[1]}

の3つがありますが、RunspaceConfiguration.Scripts.Append()では、最初の方法は使えないようです。 PowerShell上で最初の方法で定義したとしても、内部では2番目の方法で記録されており、 PowerShellを起動して下記のコマンドを打ち込んで確認できます。

PS> function add([double]$a, [double]$b){$a+$b}
PS> type function:add
param([double]$a, [double]$b) $a+$b

ここで出てくる内容がPowerShellの正規の関数表現だということなのでしょう。 普段最初の方法で関数を定義している場合、一度PowerShell上で定義したりdir function:で出てくる関数を適当に選んで、 type function:関数名で確認するといいでしょう。

引数はRunspaceInvoke、パイプラインどちらの方法でも指定可能です。 パイプラインの場合には、パイプラインから入れる全オブジェクトに共通の指定を引数で渡すと良いでしょう。 ただし文字列で表現できないような指定ならば、パイプラインからオブジェクトを入れる必要があります。