Functions/Read-HostWithDefault.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
function Read-HostWithDefault { <# .SYNOPSIS A wrapper for Read-Host that includes a default value. Optionally can provide a prompt. .DESCRIPTION A wrapper for Read-Host that includes a default value. Optionally can provide a prompt. .PARAMETER Default A required parameter indicating what the default return value will be if the user just hits [Enter] .PARAMETER Prompt A string template for the prompt string. Defaults to 'Enter a password value or accept default of'. Resulting prompt with this template would be "Enter a password value or accept default of [$Default]" .EXAMPLE $password = Read-HostWithDefault -Default 'SuperSecretPassword' Would prompt the user with: 'Enter a password value or accept default of [SuperSecretPassword]:' and store the result in $password .EXAMPLE $username = Read-HostWithDefault -Default 'sa' -Prompt 'Enter a SQL user login or accept default of' Would prompt the user with: 'Enter a SQL user login or accept default of [sa]:' and store the result in $username .OUTPUTS [string] .LINK Read-Host #> [CmdletBinding(ConfirmImpact='Low')] [OutputType('string')] param( [parameter(Mandatory,HelpMessage='Please enter what the default value will be if user just hits [Enter]')] [string] $Default, [parameter()] [string] $Prompt = 'Enter a password value or accept default of' ) begin { Write-Verbose -Message "Starting [$($MyInvocation.Mycommand)]" } process { $Response = Read-Host -Prompt ($Prompt + " [$Default]") if ('' -eq $response) { Write-Output -InputObject $Default } else { Write-Output -InputObject $Response } } end { Write-Verbose -Message "Ending [$($MyInvocation.Mycommand)]" } } #EndFunction Read-HostWithDefault |