PowerShell の自作関数の引数の ScriptBlock 内で &_ を使う方法

Question

以下のような関数を作成し、profile.ps1 で Import-Module することで PowerShell のコマンド画面から使用できるようにしました。しかし、パイプラインで$_と一緒に使ったときに意図した挙動とならず、困っています。

function Start-ScriptBlock
{
    Param(
        [System.Management.Automation.ScriptBlock]$func
    )

    process {
        $func.Invoke()
    }
}

内容は質問用に省略してあります。
もともとは Java の StreamAPI の anyMatch() のような関数を作ろうとしていました...

上記の関数を以下のように呼び出しても$_にパイプラインから受け取った内容が格納されず、意図した動作となりません。

PS D:\tmp>@("abc", "123") | Start-ScriptBlock {Write-Host Test: $_}

Test:
Test:

ForEach-Object や Where-Object のように ScriptBlock の中で $_ によってパイプラインで渡されたオブジェクトを使用するためにはどのようにすればいいでしょうか？

PSVersion は 5.0 です。

ご存知の方がおられましたら、お教えください。
よろしくお願いいたします。

6/20 追記：
function を定義とその呼び出しを同じ .ps1 ファイル内で行った場合は、正常に動作しました。

しかし、.psm1 ファイルにて function の定義を行い、それを Import-Module して呼び出そうとすると意図した挙動になりませんでした（$_にオブジェクトが入らない）。

Comments

[imihito]

Windows PowerShelll（PSVersion 5.1.16299.492）では質問のコードで問題無く動作するようです。

[okaryu]

確認していただきありがとうございます。追記させていただきましたが、確認いただいた手順は、.psm1にて関数を定義してそれを Import-Module で取り込んで呼び出すようにしていただけましたでしょうか？

Answer 1

こんにちは。

自動変数$_はAbout Automatic Variablesに

Contains the current object in the pipeline object.

とある様に、パイプラインによって伝播されるオブジェクトに対して設定される自動変数です。
単純に自作のスクリプトブロック内で$_を定義してもパイプラインを介在しない場合は何も設定されません。

このため、提示のStart-ScriptBlockに対して以下の2パターンどちらかの変更が必要になります。

解1. ForEach-Objectを使う

単純な解決方法です。
パイプラインを介在させれば良いので以下の様にForEach-Objectの引数としてスクリプトブロックを実行させれば$_が設定されます。

function Start-ScriptBlock {
    Param(
        [System.Management.Automation.ScriptBlock]$func
    )

    process {
        $_ | ForEach-Object -Process $func
    }
}

ただ、この場合だとスクリプトブロックの内容に制限が出るかもしれません。
(やりたい事次第だとは思いますが...)

解2. ScriptBlock.InvokeWithContextメソッドを使う

スクリプトブロックを実行する際にInvokeメソッドでなく、InvokeWithContextメソッドを使うと$input、$_、$this自動変数を初期設定してやることができます。

以下の例では$_自動変数を初期設定する例になります。

function Start-ScriptBlock {
    Param(
        [System.Management.Automation.ScriptBlock]$func
    )

    process {
        $variables = [System.Collections.Generic.List[PSVariable]] @()
        $variables.Add((Get-Variable _))
        $func.InvokeWithContext($null, $variables)
    }
}

Comments

[okaryu]

ありがとうございます。どちらの方法でも意図した結果を得られました！