public/Remove-File.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
<#
    .Synopsis
        Remove a file if it exists.
    .Description
        Remove a file if it exists.
    .Example
        PS C:\> Remove-File -Path "C:\Temp\file.txt"
        Removes "file.txt" if it exists.
#>

function Remove-File {
    [CmdletBinding(SupportsShouldProcess = $true)]
    param (
        # The location of the file to remove.
        [Parameter(Mandatory = $true)]
        [String]
        $Path
    )

    begin {
        Write-LogMessage -Message "Started execution"
    }

    process {
        if ((Test-Path -Path $Path) -and $PSCmdlet.ShouldProcess($Path, "removing file")) {
            Remove-Item -Force -Path $Path
        }
    }

    end {
        Write-LogMessage -Message "Finished execution"
    }
}