Public/Remove-WinSCPSession.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
function Remove-WinSCPSession {

    [CmdletBinding(
        ConfirmImpact = "Low",
        HelpUri = "https://github.com/dotps1/WinSCP/wiki/Remove-WinSCPSession",
        SupportsShouldProcess = $true
    )]
    [OutputType([ Void]
    )]

    param (
        [Parameter(
            Mandatory = $true,
            ValueFromPipeline = $true
        )]
        [WinSCP.Session]
        $WinSCPSession
    )

    try {
        $shouldProcess = $PSCmdlet.ShouldProcess(
            $WinSCPSession
        )
        if ($shouldProcess) {
            $WinSCPSession.Dispose()
        }
    } catch {
        $PSCmdlet.WriteError(
            $_
        )
    } finally {
        (Get-Command -Module WinSCP -ParameterName WinSCPSession).ForEach({
            $Global:PSDefaultParameterValues.Remove(
                "$($_.Name):WinSCPSession"
            )
        })
    }
}