目次
PowerShellでの関数の作り方を紹介します!
今回は、PowerShellでの関数の作り方について説明します。
ここでは、以下について紹介します。
・基本的な作り方
・引数
・引数の型指定
・引数の参照渡し
・引数のデフォルト値
・戻り値
・複数の戻り値
関数を作成することで、効率的にスクリプトを作成することができます。
PowerShellでの関数の作り方に興味のある方はぜひご覧ください。
基本的な作り方
PowerShellでの関数の基本的な作り方を紹介します。まずは、引数なし、戻り値なしの関数を作成してみます。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
|
PS C:\> function Sample-Func {
>> Write-Host "PowerShell function"
>> }
PS C:\> Sample-Func
PowerShell function
PS C:\>
|
引数
PowerShellでの関数の引数について紹介します。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
|
PS C:\> function Sample-Add-Func($x, $y) {
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>
|
このように引数リストを指定します。
引数には param キーワードを使用することもできます。
1
2
3
4
5
6
7
|
PS C:\> function Sample-Add-Func {
>> param($x, $y)
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>
|
また、自動変数である$argsを使用することもできます。第1引数が$args[0]、第2引数が$args[1]、…となります。
1
2
3
4
5
6
|
PS C:\> function Sample-Add-Func {
>> Write-Host ($args[0] + $args[1])
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>
|
PowerShellでの関数の引数の記述方法は上記のようなものがあります。
引数の型指定
先ほどの引数を指定した関数について、文字列を入力するとどうなるでしょうか。
1
2
3
4
5
6
|
PS C:\> function Sample-Add-Func($x, $y) {
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func "1" "2"
12
PS C:\>
|
文字列が連結されて表示されています。これは、引数の型を指定していないためです。
PowerShellでの関数の引数型を指定する方法を紹介します。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
7
8
|
PS C:\> function Sample-Add-Func([int]$x, [int]$y) {
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\> Sample-Add-Func "1" "2"
3
PS C:\>
|
文字列を指定しても、数字にキャストして加算していることが分かります。このようにPowerShellでは、関数の引数型を指定できます。
引数の参照渡し
PowerShellの関数における、引数の参照渡しについて紹介します。[ref]を指定します。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
PS C:\> $val1 = 1
PS C:\> $val2 = 2
PS C:\> # val1およびval2の出力
PS C:\> Write-Host $val1 $val2
1 2
PS C:\> # 引数の参照渡し[ref]
PS C:\> function Sample-Inc-Func([ref]$x, [ref]$y) {
>> $x.Value = $x.Value + 1
>> $y.Value = $y.Value + 1
>> }
PS C:\> # 関数の呼び出し。[ref]を付ける
PS C:\> Sample-Inc-Func ([ref]$val1) ([ref]$val2)
PS C:\> # val1およびval2の出力
PS C:\> Write-Host $val1 $val2
2 3
PS C:\>
|
関数を呼び出した後に、val1およびval2の値がインクリメントされています。引数が参照渡しされていることが分かります。
引数のデフォルト値
PowerShellの関数における、引数のデフォルト値について紹介します。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
7
8
9
10
11
12
13
|
PS C:\> function Sample-Add-Func($x = 1, $y = 2){
>> Write-Host ($x + $y)
>> }
PS C:\> # 引数なしなので、1+2が実行される
PS C:\> Sample-Add-Func
3
PS C:\> # 第1引数しか指定していないので、第2引数のデフォルト値(2)が使用される
PS C:\> Sample-Add-Func 2
4
PS C:\> # 引数を2つ指定しているので、通常の加算
PS C:\> Sample-Add-Func 2 3
5
PS C:\>
|
このようにPowerShellでは、引数を指定しなかった場合、デフォルト値が適用するように記述できます。
戻り値
PowerShellの関数における、戻り値の指定方法について紹介します。実際のコマンドを見てみましょう。
1
2
3
4
5
6
7
|
PS C:\> function Sample-Add-Func($x = 1, $y = 2){
>> return ($x + $y)
>> }
PS C:\> $res = Sample-Add-Func 1 2
PS C:\> $res
3
PS C:\>
|
return文を記述することで、戻り値を返すことができます。
boolの戻り値を返す関数は、$true / $falseを返すように記述します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
PS C:\> function Sample-Is-Even([int]$num) {
>> If($num % 2 -eq 0){
>> return $true
>> } Else {
>> return $false
>> }
>> }
PS C:\> Sample-Is-Even 1
False
PS C:\> Sample-Is-Even 2
True
PS C:\> Sample-Is-Even 3
False
PS C:\> Sample-Is-Even 4
True
PS C:\>
|
複数の戻り値
複数の戻り値を返したい場合、どうすればよいでしょうか。配列をreturnすることで複数の戻り値となります。
実際のコマンドを見てみましょう。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
PS C:\> function Sample-Multi-Ret {
>> return "ret1", "ret2", "ret3"
>> }
PS C:\> $ret = Sample-Multi-Ret
PS C:\> $ret
ret1
ret2
ret3
PS C:\> $ret.GetType()
IsPublic IsSerial Name BaseType
-------- -------- ---- --------
True True Object[] System.Array
PS C:\>
|
複数の戻り値が返されていることが分かります。
まとめ
いかがでしたでしょうか。PowerShellでの関数の作り方について説明しました。引数や戻り値の指定方法をメインで紹介しました。関数を作成することで、効率的にスクリプトを作成することができます。
ぜひご自身でコマンドを書いて、理解を深めてください。
インフラエンジニア専門の転職サイト「FEnetインフラ」
FEnetインフラはサービス開始から10年以上『エンジニアの生涯価値の向上』をミッションに掲げ、多くのエンジニアの就業を支援してきました。
転職をお考えの方は気軽にご登録・ご相談ください。