Helpers/Show-ErrorMessage.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
<#
    .SYNOPSIS
        Shows an error message on the PowerShell host.
 
    .DESCRIPTION
        Uses the internal .NET method WriteErrorLine() of the host UI class to
        show the error message on the console.
 
    .INPUTS
        None.
 
    .OUTPUTS
        None.
 
    .EXAMPLE
        PS C:\> Show-ErrorMessage -Message 'My Error Message'
        Show the error message.
 
    .NOTES
        Author : Claudio Spizzi
        License : MIT License
 
    .LINK
        https://github.com/claudiospizzi/ScriptLogger
#>


function Show-ErrorMessage
{
    param
    (
        # The error message.
        [Parameter(Mandatory = $true)]
        [System.String]
        $Message
    )

    # Add the prefix ERROR: because WriteErrorLine() does not write it itself.
    $Host.UI.WriteErrorLine("ERROR: $Message")
}