PoshFunctions

2.2.9

Functions/Set-Scrolllock.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
66
67
68
69
 function Set-Scrolllock {
<#
.SYNOPSIS
    Sets the state of the ScrollLock button.
.DESCRIPTION
    Sets the state of the ScrollLock button. It first determines the state of the ScrollLock and then acts accordingly.
.PARAMETER On
    A switch parameter to determine if you want the ScrollLock on.
.PARAMETER Off
    A switch parameter to determine if you want the ScrollLock off.
.EXAMPLE
    Set-ScrollLock
    Will turn on the ScrollLock
.EXAMPLE
    Set-ScrollLock -Off
    Will turn off the ScrollLock
.NOTES
    Inspiration: # Inspired by https://gallery.technet.microsoft.com/on-off-keyboad-lock-keys-6ba9885c
    Changes: Created function to set on or off the ScrollLock. Requires use of helper function Test-IsScrollLock
.LINK
    Wscript.Shell
#>

    [CmdletBinding(ConfirmImpact='Low',SupportsShouldProcess,DefaultParameterSetName='On')]
    [OutputType($null)]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter','')]
    Param(
        [parameter(ParameterSetName='On')]
        [switch] $On,

        [parameter(ParameterSetName='Off')]
        [switch] $Off
    )

    begin {
        Write-Verbose -Message "Starting [$($MyInvocation.Mycommand)]"
        Write-Verbose -Message "ParameterSetName [$($PsCmdlet.ParameterSetName)]"
    }

    process {
        $CurrentState = Test-IsScrollLock -Verbose:$false
        $ShouldMessage = "ScrollLock currently [$($CurrentState.ToString().ToUpper())] and desired state is [$($On.ToString().ToUpper())]"
        if ($PSCmdlet.ShouldProcess($ShouldMessage)) {
            if ($CurrentState -eq $true) {
                write-verbose -Message 'ScrollLock is currently ON'
                if ($PsCmdlet.ParameterSetName -eq 'Off') {
                    write-verbose -Message 'Setting ScrollLock to OFF'
                    $wShell = New-Object -ComObject wscript.shell -ErrorAction Stop
                    $wShell.SendKeys('{ScrollLock}')
                    remove-variable -name wShell
                }
            } else {
                write-verbose -Message 'ScrollLock is currently OFF'
                if ($PsCmdlet.ParameterSetName -eq 'On') {
                    Write-Verbose -Message 'Setting ScrollLock to ON'
                    $wShell = New-Object -ComObject wscript.shell -ErrorAction Stop
                    $wShell.SendKeys('{ScrollLock}')
                    Remove-Variable -Name wShell
                }
            }
        }
    }

    end {
        Write-Verbose -Message "Ending [$($MyInvocation.Mycommand)]"
    }

} #EndFunction Set-Scrolllock