[PowerShell][基本] 引数にデフォルト値を設定する

PowerShell

2023.04.03

本記事の概要

PowerShellの関数では、引数にデフォルト値を設定することができます。

この記事では、引数にデフォルト値を設定する方法について説明します。

PowerShellの関数では、引数にデフォルト値を設定することができます。この場合、引数が渡されなかった場合に、デフォルト値が使われます。

引数の初期値を設定するには、以下のように引数の後ろに “= <初期値>” という形式で値を指定します。

function <関数名> {
    param (
        [string]$firstName = "John",
        [string]$lastName = "Doe"
    )
    Write-Output "$lastName, $firstName"
}

この関数では、$firstNameと$lastNameという2つの引数があります。引数の後ろに”= <初期値>”を指定して、それぞれの引数に初期値を設定しています。

この関数を呼び出す場合、以下のように引数を指定することができます。

Get-FullName -firstName "Jane"

この場合、$firstNameに”Jane”が渡され、$lastNameにはデフォルト値の”Doe”が使用されます。

また、以下のように引数を指定しない場合、デフォルト値が使用されます。

Get-FullName

この場合、$firstNameにデフォルト値の”John”が、$lastNameにデフォルト値の”Doe”が使用されます。

引数の初期値を設定することで、引数の省略を許容しながらも、デフォルト値によって適切な処理を行うことができます。また、コードの記述量を減らすことができるため、コードの可読性を向上させることができます。