WindowsStartKeyControl

1.0.2.0

en-US/WindowsStartKeyControl.psm1-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
        <command:details>
            <command:name>Get-WinKeyDisabled</command:name>
            <maml:description>
                <maml:para>The Windows keyboard start Key Control.</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>WinKeyDisabled</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Check if the Windows keyboard start key is disabled or enabled.
Change the Windows keyboard start key state.
When checking state command returns:
$true - when start key is DISABLED.
$false - when ENABLED.
Optional GUI mode.</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="WinKeyDisabled">
                <maml:name>Get-WinKeyDisabled</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Action</maml:name>
                    <maml:description>
                        <maml:para>&#39;GetState&#39; is the default &#39;Action&#39; parameter, &#39;SwitchState&#39; on/off button. &#39;Repair&#39; removes the bad registry value.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>StartGUI</maml:name>
                    <maml:description>
                        <maml:para></maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Action</maml:name>
                <maml:description>
                    <maml:para>&#39;GetState&#39; is the default &#39;Action&#39; parameter, &#39;SwitchState&#39; on/off button. &#39;Repair&#39; removes the bad registry value.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>StartGUI</maml:name>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:returnValues>
            <command:returnValue>
                <dev:type>
<maml:name>System.Boolean</maml:name>
                <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>by chixus - CHXOFT.</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-WinKeyDisabled </dev:code>
                <dev:remarks>
                    <maml:para>- Results in bolean ($true or $false). If the key is deactivated returns $true, if it is the default (on) returns $false.
 
PS C:\&gt; Get-WinKeyDisabled -Action GetState
- As well as the above command, it is the default &#39;Action&#39; switch.
 
PS C:\&gt; Get-WinKeyDisabled -Action SwitchState
- Switching the key status, if key enabled it disables it and reverse. No effects until the computer is restarted.
 
PS C:\&gt; Get-WinKeyDisabled -GUI
- Open GUI mode.</maml:para>
 
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
</helpItems>