Public/Remove-WinSCPItem.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 |
function Remove-WinSCPItem { [CmdletBinding( ConfirmImpact = "High", HelpUri = "https://github.com/dotps1/WinSCP/wiki/Remove-WinSCPItem", SupportsShouldProcess = $true )] [OutputType( [Void] )] param ( [Parameter( Mandatory = $true, ValueFromPipeline = $true )] [ValidateScript({ if ($_.Opened) { return $true } else { throw "The WinSCP Session is not in an Open state." } })] [WinSCP.Session] $WinSCPSession, [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true )] [String[]] $Path ) process { foreach ($pathValue in ( Format-WinSCPPathString -Path $Path )) { $cmdletShouldProcess = $PSCmdlet.ShouldProcess( $pathValue ) if ($cmdletShouldProcess) { try { $result = $WinSCPSession.RemoveFiles( $pathValue ) if (-not ( $result.IsSuccess )) { $result.Failures[0] | Write-Error } } catch { $PSCmdlet.WriteError( $_ ) } } } } } |