mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2024-12-15 03:59:15 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
5914fc1ffd
PowerToys/doc/devdocs/modules/launcher/plugins/system.md
Heiko 314425e32e
[PT Run] System commands plugin: Update dev docs and UnitTests (#15832) 
* update UnitTests

* dev docs

* fix plugin name

* fix spelling

* fix path

* improvement

* fix table
2022-02-04 16:56:31 +00:00

2.4 KiB
Raw Blame History

Windows System Commands Plugin

As the name suggests, the Windows System Commands Plugin is used to directly run Windows system commands that have been entered by the user as a query. This is done by parsing the entry and validating the command, followed by executing it.

The user can change the behavior of the plugin (language, confirmation dialog, ...) with optional plugin settings.

Image of System Commands plugin

Available commands:

  • Shutdown
  • Restart
  • Sign Out
  • Lock
  • Sleep
  • Hibernate
  • Empty Recycle Bin
  • UEFI Firmware Settings (Only available on systems, that boot in UEFI mode.)

Optional plugin settings

  • We have the following settings that the user can configure to change the behavior of the plugin:

    Key Default value Name/Description
    ConfirmSystemCommands` | false` | how a dialog to confirm system commands |
    LocalizeSystemCommands` | true` | se localized system commands instead of English ones |

  • The optional plugin settings are implemented via the ISettingProvider interface from Wox.Plugin project. All available settings for the plugin are defined in the Main class of the plugin.

Technical details

Main

  • Tries to parse the user input and returns a specific Windows system command by using a Result list.

  • While parsing, the plugin uses FuzzyMatch to get characters matching a result in the list.

UEFI command

  • The UEFI command is only available on systems, that boot in UEFI mode.

  • This is validated by checking the result of the method GetSystemFirmwareType, which uses the native method GetFirmwareType in kernel32.dll.

Score

  • CalculateSearchScore A match found near the beginning of a string is scored more than a match found near the end. A match is scored more if the characters in the patterns are closer to each other, while the score is lower if they are more spread out.