PowerShellでの関数の作成方法とは？引数や戻り値の指定方法を解説

PowerShell

エンジニア
テクノロジー

公開日時: 2021-01-22 　更新日時: 2022-04-26

この記事でわかること

PowerShellでの関数の作り方を紹介します！

今回は、PowerShellでの関数の作り方について説明します。

ここでは、以下について紹介します。
・基本的な作り方
・引数
・引数の型指定
・引数の参照渡し
・引数のデフォルト値
・戻り値
・複数の戻り値
関数を作成することで、効率的にスクリプトを作成することができます。

PowerShellでの関数の作り方に興味のある方はぜひご覧ください。

基本的な作り方

PowerShellでの関数の基本的な作り方を紹介します。まずは、引数なし、戻り値なしの関数を作成してみます。

実際のコマンドを見てみましょう。

PS C:\> function Sample-Func {
>> Write-Host "PowerShell function"
>> }
PS C:\> Sample-Func
PowerShell function
PS C:\>

PS C:\> function Sample-Func {

>> Write-Host "PowerShell function"

>> }

PS C:\> Sample-Func

PowerShell function

PS C:\>

引数

PowerShellでの関数の引数について紹介します。

実際のコマンドを見てみましょう。

PS C:\> function Sample-Add-Func($x, $y) {
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>

PS C:\> function Sample-Add-Func($x, $y) {

>> Write-Host ($x + $y)

>> }

PS C:\> Sample-Add-Func 1 2

PS C:\>

このように引数リストを指定します。

引数には param キーワードを使用することもできます。

PS C:\> function Sample-Add-Func {
>> param($x, $y)
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>

PS C:\> function Sample-Add-Func {

>> param($x, $y)

>> Write-Host ($x + $y)

>> }

PS C:\> Sample-Add-Func 1 2

PS C:\>

また、自動変数である$argsを使用することもできます。第1引数が$args[0]、第2引数が$args[1]、…となります。

PS C:\> function Sample-Add-Func {
>> Write-Host ($args[0] + $args[1])
>> }
PS C:\> Sample-Add-Func 1 2
3
PS C:\>

PS C:\> function Sample-Add-Func {

>> Write-Host ($args[0] + $args[1])

>> }

PS C:\> Sample-Add-Func 1 2

PS C:\>

PowerShellでの関数の引数の記述方法は上記のようなものがあります。

引数の型指定

先ほどの引数を指定した関数について、文字列を入力するとどうなるでしょうか。

PS C:\> function Sample-Add-Func($x, $y) {
>> Write-Host ($x + $y)
>> }
PS C:\> Sample-Add-Func "1" "2"
12
PS C:\>

PS C:\> function Sample-Add-Func($x, $y) {

>> Write-Host ($x + $y)

>> }

PS C:\> Sample-Add-Func "1" "2"

PS C:\>

文字列が連結されて表示されています。これは、引数の型を指定していないためです。

PowerShellでの関数の引数型を指定する方法を紹介します。

実際のコマンドを見てみましょう。

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:\>

PS C:\> function Sample-Add-Func([int]$x, [int]$y) {

>> Write-Host ($x + $y)

>> }

PS C:\> Sample-Add-Func 1 2

PS C:\> Sample-Add-Func "1" "2"

PS C:\>

文字列を指定しても、数字にキャストして加算していることが分かります。このようにPowerShellでは、関数の引数型を指定できます。

引数の参照渡し

PowerShellの関数における、引数の参照渡しについて紹介します。[ref]を指定します。

実際のコマンドを見てみましょう。

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:\>

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の関数における、引数のデフォルト値について紹介します。

実際のコマンドを見てみましょう。

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:\>

PS C:\> function Sample-Add-Func($x = 1, $y = 2){

>> Write-Host ($x + $y)

>> }

PS C:\> # 引数なしなので、1+2が実行される

PS C:\> Sample-Add-Func

PS C:\> # 第1引数しか指定していないので、第2引数のデフォルト値(2)が使用される

PS C:\> Sample-Add-Func 2

PS C:\> # 引数を2つ指定しているので、通常の加算

PS C:\> Sample-Add-Func 2 3

PS C:\>

このようにPowerShellでは、引数を指定しなかった場合、デフォルト値が適用するように記述できます。

戻り値

PowerShellの関数における、戻り値の指定方法について紹介します。実際のコマンドを見てみましょう。

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:\>

PS C:\> function Sample-Add-Func($x = 1, $y = 2){

>> return ($x + $y)

>> }

PS C:\> $res = Sample-Add-Func 1 2

PS C:\> $res

PS C:\>

return文を記述することで、戻り値を返すことができます。

boolの戻り値を返す関数は、$true / $falseを返すように記述します。

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:\>

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することで複数の戻り値となります。

実際のコマンドを見てみましょう。

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:\>

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での関数の作り方について説明しました。引数や戻り値の指定方法をメインで紹介しました。関数を作成することで、効率的にスクリプトを作成することができます。

ぜひご自身でコマンドを書いて、理解を深めてください。

ネプラス株式会社はサービス開始から10年以上
『エンジニアの生涯価値の向上』をミッションに掲げ、
多くのインフラエンジニア・ネットワークエンジニアの就業を支援してきました。

ネプラス株式会社はこんな会社です

秋葉原オフィスにはネプラス株式会社をはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

インフラ業界に特化

ネットワーク・サーバー・データベース等、ITインフラ業界に特化。Cisco Systemsプレミアパートナーをはじめ各種ベンダーのパートナー企業です。

業界を知り尽くしているからこそ大手の取引先企業、経験豊富なエンジニアに選ばれています。
正社員なのにフリーランスのような働き方

正社員の方でも希望を聞いたうえでプロジェクトをアサインさせていただいており、フリーランスのような働き方が可能。帰社日もありません。

プロジェクト終了後もすぐに次の案件をご紹介させていただきますのでご安心ください。
大手直取引の高額案件

案件のほとんどが大手SIerやエンドユーザーからの直取引のためエンジニアの皆様へに高く還元できています。

Ciscoをはじめ、Juniper、Azure、Linux、AWS等インフラに特化した常時300件以上の案件があります。
スキルアップ支援

不要なコストを削減し、その分エンジニアの方へのスキルアップ支援(ネットワーク機器貸出、合格時の受験費用支給など)や給与で還元しています。

受験費用例）CCNP,CCIE:6-20万円、JNCIS:3-4万円、AWS:1-3万円など

※業務に関連する一定の資格のみ。各種条件がありますので詳しくは担当者へにお尋ねください。
現給与を保証します！※

前職の給与保証しており、昨年度は100%の方が給与アップを実現。収入面の不安がある方でも安心して入社していただけます。

※適用にはインフラエンジニアの業務経験1年以上、等一定の条件がございます。
インセンティブ制度

ネットワーク機器の販売・レンタル事業等、売上に貢献いただいた方にはインセンティブをお支払いしています。

取引先企業とエンジニア側、双方にメリットがあり大変好評をいただいています。
社会保険・福利厚生

社員の方は、社会保険を完備。健康保険は業界内で最も評価の高い「関東ITソフトウェア健康保険組合」です。

さらに様々なサービスをお得に利用できるベネフィットステーションにも加入いただきます。
東証プライム上場企業グループ

ネプラスは東証プライム上場「株式会社オープンアップグループ」のグループ企業です。

安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。