Friendly Parameter Prompts with 'HelpMessage'

Normally the variable name assigned to the parameter becomes the label which is presented to the user when executing the script.

You may want something a little friendlier, and if so, you are in luck. If you provide HelpMessage information, as shown below, VitalSigns will use that to prompt the user.

[Parameter(Mandatory=$true, HelpMessage="HTML signature file")] [System.IO.FileInfo] $HtmlFilename

For example the following parameters will produce the following user prompt

   param(
    [Parameter(Mandatory=true)] [string]$Name,
    [Parameter(Mandatory=$true, HelpMessage="HTML signature file")] [System.IO.FileInfo] $HtmlFilename ,
    [Parameter(Mandatory=$false, HelpMessage = "Plain text signature file")] [System.IO.FileInfo] $TextFilenameFilename 
)

VitalSigns and PowerScripts365 Documentation

Friendly Parameter Prompts with 'HelpMessage'

Analytics

Related content