PoshFunctions

2.2.9

Functions/Move-ToRecycleBin.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
54
55
56
57
58
59
60
61
62
63
64
65
 function Move-ToRecycleBin {
<#
.SYNOPSIS
    Instead of outright deleting a file, why not move it to the Recycle Bin?
.DESCRIPTION
    Instead of outright deleting a file, why not move it to the Recycle Bin?
    Function aliased to 'Recycle'
.PARAMETER Path
    A string or array of strings representing a file or a folder. Wildcards are
    acceptable and will be resolved to specific file or folder names. Can accept
    values from the pipeline.
.EXAMPLE
    Move-ToRecycleBin -Path c:\temp\dummyfile.txt -Verbose
 
    VERBOSE: Moving 'c:\temp\dummyfile.txt' to the Recycle Bin
.EXAMPLE
    Move-ToRecycleBin -Path c:\temp\dummyfile2.txt
 
    Would move c:\temp\dummyfile2.txt to the Recycle Bin
.EXAMPLE
    Move-ToRecycleBin .\FileDoesNotExist
 
    Move-ToRecycleBin : ERROR: Path [.\FileDoesNotExist] does not exist
.EXAMPLE
    Move-ToRecycleBin -Path 'File1.txt', 'File2.txt'
 
    Would move both File1.txt and File2.txt to the Recycle Bin
#>

    [CmdletBinding(ConfirmImpact = 'Medium')]
    [alias('Recycle')]
    param (
        [Parameter(Mandatory, HelpMessage='Please enter a path to a file or folder. Wildcards accepted.', ValueFromPipeline, ValueFromPipelineByPropertyName)]
        [string[]] $Path
    )

    begin {
        $FileSystem = New-Object -TypeName 'Microsoft.VisualBasic.FileIO.FileSystem'
        Write-Verbose -Message "Starting [$($MyInvocation.MyCommand)]"
    }

    process {
        foreach ($currentPath in $Path) {
            if (Test-Path -Path $currentPath) {
                $File = Resolve-Path -Path $currentPath
                foreach ($currentFile in $File) {
                    Write-Verbose -Message ("Moving '{0}' to the Recycle Bin" -f $currentFile)
                    if (Test-Path -Path $currentFile -PathType Container) {
                        $FileSystem::DeleteDirectory($currentFile, 'OnlyErrorDialogs', 'SendToRecycleBin')
                    } else {
                        $FileSystem::DeleteFile($currentFile, 'OnlyErrorDialogs', 'SendToRecycleBin')
                    }
                }
            } else {
                Write-Error -Message "ERROR: Path [$currentPath] does not exist"
            }
        }
    }

    end {
        Remove-Variable -Name FileSystem
        Write-Verbose -Message "Ending [$($MyInvocation.MyCommand)]"
    }
}