functions/SPClientContext/Disconnect-SPClientContext.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
#Requires -Version 3.0

<#
  Disconnect-SPClientContext.ps1
 
  Copyright (c) 2017 karamem0
 
  This software is released under the MIT License.
  https://github.com/karamem0/SPClient/blob/master/LICENSE
#>


function Disconnect-SPClientContext {

<#
.SYNOPSIS
  Disconnects from SharePoint site.
.DESCRIPTION
  The Disconnect-SPClientContext function disposes the current client context.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.EXAMPLE
  Disconnect-SPClientContext
.INPUTS
  None
.OUTPUTS
  None
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/Disconnect-SPClientContext.md
#>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        $ClientContext.Dispose()
        $ClientContext = $null
    }

}