Windowsのポチポチ業務を爆速化するPowerShell、関数をコンソールで登録して呼び出す方法

みなさんこんにちは、テラド(@terashin1226)です！

Windowsのポチポチ業務（マウスを使った業務）を爆速化するために、PowerShellを使った効率化の方法をお伝えしています。

前回はPowerShellで関数を作ってスクリプトから呼び出す方法を方法をお伝えしました。

Windowsのポチポチ業務を爆速化するPowerShell、関数を作ってスクリプトから呼び出す方法

Windowsのポチポチ業務（＝マウスを使った業務）を爆速化するPowerShell。今回はPowerShellで関数を作ってスクリプトから呼び出す方法をご紹介します！複雑な処理、記述量が多い処理は関数にしておくことで繰り返し使用でき便利です！

今回はPowerShellで作った関数をコンソールで登録して呼び出す方法をお伝えします。

コマンドレットのように自分で作った関数をコンソールから自由に呼び出しちゃいましょう。

それではいってみましょう！

前回のおさらい
コンソールから関数を登録して呼び出す方法
まとめ
連載目次：Windowsのポチポチ業務を爆速化するPowerShell

前回のおさらい

前回は引数2つを加算した答えを返してくれる関数「Add-Number」を作成し、スクリプト内から呼び出しました。

以下のようなスクリプトです。


function Add-Number($num1,$num2){
    $answer = $num1 + $num2
    return $answer
}

Add-Number 1 2

このように関数自体とその呼び出しを1つのスクリプト内で記述しました。

スクリプトは上から順番に解釈されますので、実行すると

1 関数がPowerShellに登録される
2 登録された関数Add-Numberを呼び出す

という処理の流れとなっています。

スクリプト内で完結しているように思えますが、関数が一旦はPowerShellに登録されているということを覚えておいてください。

コンソールから関数を登録して呼び出す方法

では、関数「Add-Number」をPowerShellのコンソールで登録して呼び出す方法をお伝えしていきますよ！

まずは以下のスクリプトをISEのスクリプトウィンドウに入力し、デスクトップに「sample.ps1」という名称で保存してください。前回作成した関数の呼び出しの部分は削除してくださいね。


function Add-Number($num1,$num2){
    $answer = $num1 + $num2
    return $answer
}

PowerShellに関数を登録する

さきほどご説明したとおり、まず関数をPowerShellに登録する必要があります。

登録方法は簡単で、関数を書いたスクリプトのフルパスをコンソールから入力するだけです。

エンターを押すと、なにも起こらずにプロンプトが再度表示されます。

登録が無事完了しているか、関数を呼び出して確かめてみましょう！

前回ご紹介した関数の呼び出し方は以下のとおりでしたね。コンソールから呼び出す場合もまったく同じです。

関数名引数1に入力する値引数2に入力する値 …

$num1に1、$num2に2を入力することにし、以下のように書きます。

Add-Number 1 2

コンソールで「Add-Number 1 2」として実行すると…

あれ、以下のようにエラーになってしまいました。

Add-Number : 用語 ‘Add-Number’ は、コマンドレット、関数、スクリプトファイル、または操作可能なプログラムの名前として認識されません。名前が正しく記述されていることを確認し、パスが含まれている場合はそのパスが正しいことを確認してから、再試行してください。
発生場所行:1 文字:1
+ Add-Number 1 2
+ ~~~~~~~~~~
+ CategoryInfo : ObjectNotFound: (Add-Number:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException

「用語 ‘Add-Number’ は、コマンドレット、関数、スクリプトファイル、または操作可能なプログラムの名前として認識されません。」と書いてありますね。どうやら呼び出しがうまくいっていないようです。

実はコンソールから関数を呼び出すにはスコープと言われる設定を変更する必要があります。

globalキーワードでスコープを変更する

コンソールから関数を呼び出すにはもうひと手間、作業が必要です。

関数名の前にglobalキーワードを付与します。

function global:関数名(引数1,引数2,…){

処理内容

return 戻り値

}

globalキーワードを付与しない場合、関数を同一スクリプト内から呼び出すことは可能ですが…

コンソールなど外部から呼び出すことができません。

globalを指定することにより外部（コンソール、ほかのスクリプト）から呼び出しが可能になります。

このように関数を呼び出せる範囲のことをスコープといいます。

実行結果

globalキーワードを付与すると、スクリプトは以下の通りとなります。

function global:Add-Number($num1,$num2){
    $answer = $num1 + $num2
    return $answer
}

では、globalキーワードを付与して呼び出しが可能となったところで再度コンソールにフルパスを入力して関数を登録してください。

その後にコンソールで関数名を途中まで入力すると…

入力補完機能により「Add-Number」が表示されました。正しく関数が登録されている証拠です。

最後まで入力し実行すると…

$answer（1+2の答え「3」）が表示されました！

今回ご紹介した方法では、PowerShellを終了しない限りは何度も関数を呼び出すことが可能です。ただし、PowerShellを終了すると登録された関数は削除されますのでご注意ください。（次回、PowerShellを終了しても関数の登録を保持する方法をご紹介します。）

まとめ

いかがだったでしょうか。

今回はPowerShellの関数をコンソールで登録して呼び出す方法をお伝えしました！関数をコンソールなど外部から呼び出すにはglobalキーワードでスコープを変更することが必要となります。

次回はコンソールからの関数の登録が不要となるプロファイルに関数を登録する方法をご紹介します！

最後までお読みいただきありがとうございました！

連載目次：Windowsのポチポチ業務を爆速化するPowerShell

Windowsのポチポチ業務（マウスを使った業務）を爆速化するために、PowerShellを使った効率化の方法をお伝えしています。