PowerShellにおける関数

関数は、呼び出し元から渡された値(引数)を基に定められた処理を行い、その結果(戻り値)を呼び出し元に返す機構である。
他のプログラミング言語(スクリプト言語を含む)と同様、PowerShellでも関数を定義して用いることができる。
尚、自身で定義する以外にも、PowerShellに標準で組み込まれた関数も同様に用いることができる。

関数定義

基本形

[]内の項目は省略可能。引数はカンマに続けて複数設定可能。

function 関数名 [(引数[=デフォルト値],...)] { 関数の本体 [return 戻り値] }

例

# $width と $height の2つの引数をとる関数 Triangle() を定義 # $width と $height はいずれも double 型 function Triangle([double] $width = 1, [double] $height = 4) { return $width * $height / 2 }

引数の型チェックを行わない場合は型名を省略可能。

function Triangle($width = 1, $height = 4) { return $width * $height / 2 }

関数呼び出し

関数を呼び出す際は

関数名引数1 引数2 ...

のように、引数を空白で区切る。
(C系言語のような括弧は不要。またカンマを用いてはならない。)

例

# 第1引数( $width ) に 4 、第2引数( $height ) に 6 を与えて呼び出し Triangle 4 6 # 結果 : 12 # 引数のラベルを明示して指定 Triangle -width 8 -height 7 # 結果 : 28 # ラベルを明示する場合は、順序は問われない Triangle -height 12 -width 6 # 結果 : 36 # 値が与えられなかった引数には、デフォルト値が(定義されていれば)適用される # (値が与えられない $width にはデフォルト値 1 が入る) Triangle -height 12 # 結果 : 6 # ($width = 1 、$height = 4 いずれもデフォルト値) Triangle # 結果 : 2

目次 :

PowerShellにおける関数

関数定義

基本形

例

関数呼び出し

例