This commit is contained in:
Paolo Matarazzo
2025-01-13 12:14:25 -05:00
parent f3ee06fe90
commit 24d6dca924
21 changed files with 40 additions and 31 deletions

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Disable all blocked key combinations # Disable all blocked key combinations
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The following sample Windows PowerShell script uses the WMI providers to disable all blocked key combinations for Keyboard Filter by using the Windows Management Instrumentation (WMI) providers for Keyboard Filter. The key combination configurations are not removed, but Keyboard Filter stops blocking any keys. The following sample Windows PowerShell script uses the WMI providers to disable all blocked key combinations for Keyboard Filter by using the Windows Management Instrumentation (WMI) providers for Keyboard Filter. The key combination configurations are not removed, but Keyboard Filter stops blocking any keys.

View File

@ -0,0 +1,10 @@
---
author: TerryWarwick
ms.author: twarwick
ms.service: windows-iot
ms.subservice: iot
ms-topic: include
ms.date: 09/30/2024
---
**Supported Editions** </br> ✅ IoT Enterprise LTSC</br>✅ IoT Enterprise</br>✅ Enterprise LTSC</br>✅ Enterprise</br>✅ Education

View File

@ -12,9 +12,9 @@ ms.topic: article
--- ---
# Keyboard Filter # Keyboard Filter
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
You can use Keyboard Filter to suppress undesirable key presses or key combinations. Normally, a customer can use certain Microsoft Windows key combinations like Ctrl+Alt+Delete or Ctrl+Shift+Tab to alter the operation of a device by locking the screen or using Task Manager to close a running application. This behavior might not be desirable if your device is intended for a dedicated purpose. You can use Keyboard Filter to suppress undesirable key presses or key combinations. Normally, a customer can use certain Microsoft Windows key combinations like Ctrl+Alt+Delete or Ctrl+Shift+Tab to alter the operation of a device by locking the screen or using Task Manager to close a running application. This behavior might not be desirable if your device is intended for a dedicated purpose.
The Keyboard Filter feature works with physical keyboards, the Windows on-screen keyboard, and the touch keyboard. Switching from one language to another might cause the location of suppressed keys on the keyboard layout to change. Keyboard Filter detects these dynamic layout changes and continues to suppress keys correctly. The Keyboard Filter feature works with physical keyboards, the Windows on-screen keyboard, and the touch keyboard. Switching from one language to another might cause the location of suppressed keys on the keyboard layout to change. Keyboard Filter detects these dynamic layout changes and continues to suppress keys correctly.
@ -27,9 +27,9 @@ The Keyboard Filter feature works with physical keyboards, the Windows on-screen
* **Configure:** To customize the setting or subsettings. * **Configure:** To customize the setting or subsettings.
* **Embedded Keyboard Filter:** This feature is called Embedded Keyboard Filter in Windows 10, version 1511. * **Embedded Keyboard Filter:** This feature is called Embedded Keyboard Filter in Windows 10, version 1511.
* **Keyboard Filter:** This feature is called Keyboard Filter in Windows 10, version 1607 and later. * **Keyboard Filter:** This feature is called Keyboard Filter in Windows 10, version 1607 and later.
## Turn on Keyboard Filter ## Turn on Keyboard Filter
@ -92,7 +92,7 @@ Keyboard Filter has the following features:
## Keyboard scan codes and layouts ## Keyboard scan codes and layouts
When a key is pressed on a physical keyboard, the keyboard sends a scan code to the keyboard driver. The driver then sends the scan code to the OS and the OS converts the scan code into a virtual key based on the current active layout. The layout defines the mapping of keys on the physical keyboard, and has many variants. A key on a keyboard always sends the same scan code when pressed, however this scan code can map to different virtual keys for different layouts. For example, in the English (United States) keyboard layout, the key to the right of the P key maps to “{“. However, in the Swedish (Sweden) keyboard layout, the same key maps to “Å”. When a key is pressed on a physical keyboard, the keyboard sends a scan code to the keyboard driver. The driver then sends the scan code to the OS and the OS converts the scan code into a virtual key based on the current active layout. The layout defines the mapping of keys on the physical keyboard, and has many variants. A key on a keyboard always sends the same scan code when pressed, however this scan code can map to different virtual keys for different layouts. For example, in the English (United States) keyboard layout, the key to the right of the P key maps to `{`. However, in the Swedish (Sweden) keyboard layout, the same key maps to `Å`.
Keyboard Filter can block keys either by the scan code or the virtual key. Blocking keys by the scan code is useful for custom keyboards that have special scan codes that don't translate into any single virtual key. Blocking keys by the virtual key is more convenient because it's easier to read and Keyboard Filter suppresses the key correctly even when the location of the key changes because of a layout change. Keyboard Filter can block keys either by the scan code or the virtual key. Blocking keys by the scan code is useful for custom keyboards that have special scan codes that don't translate into any single virtual key. Blocking keys by the virtual key is more convenient because it's easier to read and Keyboard Filter suppresses the key correctly even when the location of the key changes because of a layout change.
@ -138,9 +138,9 @@ Keyboard filter can't block the Sleep key.
Some hardware keys, such as rotation lock, don't have a defined virtual key. You can still block these keys by using the scan code of the key. Some hardware keys, such as rotation lock, don't have a defined virtual key. You can still block these keys by using the scan code of the key.
The add (+), multiply (\*), subtract (-), divide (/), and decimal (.) keys have different virtual keys and scan codes on the numeric keypad than on the main keyboard. You must block both keys to block these keys. For example, to block the multiply key, you must add a rule to block \* and a rule to block Multiply. The add (+), multiply (\*), subtract (-), divide (/), and decimal (.) keys have different virtual keys and scan codes on the numeric keypad than on the main keyboard. You must block both keys to block these keys. For example, to block the multiply key, you must add a rule to block "\*" and a rule to block Multiply.
When locking the screen by using the on-screen keyboard, or a combination of a physical keyboard and the on-screen keyboard, the on-screen keyboard sends an extra Windows logo key keystroke to the OS. If your device is using the Windows 10 shell and you use keyboard filter to block Windows logo key+L, the extra Windows logo key keystroke causes the shell to switch between the **Start** screen and the last active app when a user attempts to lock the device by using the on-screen keyboard, which may be unexpected behavior. When locking the screen by using the on-screen keyboard, or a combination of a physical keyboard and the on-screen keyboard, the on-screen keyboard sends an extra Windows logo key keystroke to the OS. If your device is using the Windows 10 shell and you use keyboard filter to block Windows logo key+L, the extra Windows logo key keystroke causes the shell to switch between the **Start** screen and the last active app when a user attempts to lock the device by using the on-screen keyboard, which may be unexpected behavior.
Some custom keyboard software, such as Microsoft IntelliType Pro, can install Keyboard Filter drivers that prevent Keyboard Filter from being able to block some or all keys, typically extended keys like BrowserHome and Search. Some custom keyboard software, such as Microsoft IntelliType Pro, can install Keyboard Filter drivers that prevent Keyboard Filter from being able to block some or all keys, typically extended keys like BrowserHome and Search.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Add blocked key combinations # Add blocked key combinations
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create three functions to configure Keyboard Filter so that Keyboard Filter blocks key combinations. It demonstrates several ways to use each function. The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create three functions to configure Keyboard Filter so that Keyboard Filter blocks key combinations. It demonstrates several ways to use each function.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Keyboard Filter key names # Keyboard Filter key names
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
You can configure Keyboard Filter to block keys or key combinations. A key combination consists of one or more modifier keys, separated by a plus sign (+), and either a key name or a key scan code. In addition to the keys listed in the following tables, you can use the predefined key combinations names as custom key combinations. However, we recommend using the predefined key settings when enabling or disabling predefined key combinations. You can configure Keyboard Filter to block keys or key combinations. A key combination consists of one or more modifier keys, separated by a plus sign (+), and either a key name or a key scan code. In addition to the keys listed in the following tables, you can use the predefined key combinations names as custom key combinations. However, we recommend using the predefined key settings when enabling or disabling predefined key combinations.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# List all configured key combinations # List all configured key combinations
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to displays all key combination configurations for Keyboard Filter. The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to displays all key combination configurations for Keyboard Filter.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Windows PowerShell script samples for Keyboard Filter # Windows PowerShell script samples for Keyboard Filter
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The list below describes sample Windows PowerShell scripts that demonstrate how to use the Windows Management Instrumentation (WMI) providers for Keyboard Filter. The list below describes sample Windows PowerShell scripts that demonstrate how to use the Windows Management Instrumentation (WMI) providers for Keyboard Filter.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Keyboard Filter WMI provider reference # Keyboard Filter WMI provider reference
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Describes the Windows Management Instrumentation (WMI) provider classes that you use to configure Keyboard Filter during run time. Describes the Windows Management Instrumentation (WMI) provider classes that you use to configure Keyboard Filter during run time.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Modify global settings # Modify global settings
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The following sample Windows PowerShell scripts use the Windows Management Instrumentation (WMI) providers to modify global settings for Keyboard Filter. The following sample Windows PowerShell scripts use the Windows Management Instrumentation (WMI) providers to modify global settings for Keyboard Filter.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Predefined key combinations # Predefined key combinations
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
This topic lists a set of key combinations that are predefined by a keyboard filter. You can list the value of the WEKF_PredefinedKey.Id to get a complete list of key combinations defined by a keyboard filter. This topic lists a set of key combinations that are predefined by a keyboard filter. You can list the value of the WEKF_PredefinedKey.Id to get a complete list of key combinations defined by a keyboard filter.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# Remove key combination configurations # Remove key combination configurations
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create two functions to remove custom-defined key combination configurations from Keyboard Filter. It demonstrates several ways to use each function. The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create two functions to remove custom-defined key combination configurations from Keyboard Filter. It demonstrates several ways to use each function.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_CustomKey # WEKF_CustomKey
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Adds or removes custom-defined key combinations. Adds or removes custom-defined key combinations.
@ -53,9 +53,9 @@ The following tables list any methods and properties that belong to this class.
### Remarks ### Remarks
You can specify key combinations by including the modifier keys in the name. The most common modifier names are Ctrl”, Shift”, Alt”, and Win”. You cannot block a combination of non-modifier keys. For example, you can block a key combination of Ctrl+Shift+F”, but you cannot block a key combination of A+D”. You can specify key combinations by including the modifier keys in the name. The most common modifier names are "Ctrl”, "Shift”, "Alt”, and "Win”. You cannot block a combination of non-modifier keys. For example, you can block a key combination of "Ctrl+Shift+F”, but you cannot block a key combination of "A+D”.
When you block a shift-modified key, you must enter the key as Shift” + the unmodified key. For example, to block the % key on an English keyboard layout, you must specify the key as Shift+5”. Attempting to block %”, results in Keyboard Filter blocking 5” instead. When you block a shift-modified key, you must enter the key as "Shift” + the unmodified key. For example, to block the % key on an English keyboard layout, you must specify the key as "Shift+5”. Attempting to block "%”, results in Keyboard Filter blocking "5” instead.
When you specify the key combination to block, you must use the English names for the keys. For a list of the key names you can specify, see Keyboard Filter key names. When you specify the key combination to block, you must use the English names for the keys. For a list of the key names you can specify, see Keyboard Filter key names.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_CustomKey.Add # WEKF_CustomKey.Add
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Creates a new custom key combination and enables Keyboard Filter to block the new key combination. Creates a new custom key combination and enables Keyboard Filter to block the new key combination.

View File

@ -11,7 +11,7 @@ ms.subservice: iot
--- ---
# WEKF_CustomKey.Remove # WEKF_CustomKey.Remove
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Removes a custom key combination, causing Keyboard Filter to stop blocking the removed key combination. Removes a custom key combination, causing Keyboard Filter to stop blocking the removed key combination.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_PredefinedKey # WEKF_PredefinedKey
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
This class blocks or unblocks predefined key combinations, such as Ctrl+Alt+Delete. This class blocks or unblocks predefined key combinations, such as Ctrl+Alt+Delete.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_PredefinedKey.Disable # WEKF_PredefinedKey.Disable
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Unblocks the specified predefined key combination. Unblocks the specified predefined key combination.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_PredefinedKey.Enable # WEKF_PredefinedKey.Enable
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
This method blocks the specified predefined key combination. This method blocks the specified predefined key combination.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_Scancode # WEKF_Scancode
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Blocks or unblocks key combinations by using the keyboard scan code, which is an integer number that is generated whenever a key is pressed or released. Blocks or unblocks key combinations by using the keyboard scan code, which is an integer number that is generated whenever a key is pressed or released.
@ -59,7 +59,7 @@ The following tables list any constructors, methods, fields, and properties that
Scan codes are generated by the keyboard whenever a key is pressed. The same physical key will always generate the same scan code, regardless of which keyboard layout is currently being used by the system. Scan codes are generated by the keyboard whenever a key is pressed. The same physical key will always generate the same scan code, regardless of which keyboard layout is currently being used by the system.
You can specify key combinations by including the modifier keys in the *Modifiers* parameter of the **Add** method or by modifying the **Modifiers** property. The most common modifier names are Ctrl”, Shift”, Alt”, and Win”. You can specify key combinations by including the modifier keys in the *Modifiers* parameter of the **Add** method or by modifying the **Modifiers** property. The most common modifier names are "Ctrl”, "Shift”, "Alt”, and "Win”.
## Example ## Example

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_Scancode.Add # WEKF_Scancode.Add
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
This method adds a new custom scan code combination and enables Keyboard Filter to block the new combination. This method adds a new custom scan code combination and enables Keyboard Filter to block the new combination.

View File

@ -13,7 +13,7 @@ ms.topic: article
--- ---
# WEKF_Scancode.Remove # WEKF_Scancode.Remove
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
This method removes a custom scan code key combination, causing Keyboard Filter to stop blocking the removed combination. This method removes a custom scan code key combination, causing Keyboard Filter to stop blocking the removed combination.

View File

@ -7,12 +7,11 @@ ms.service: windows-iot
ms.subservice: iot ms.subservice: iot
ms.date: 11/12/2024 ms.date: 11/12/2024
ms.topic: article ms.topic: article
--- ---
# WEKF_Settings # WEKF_Settings
<!-- [!INCLUDE [Supported Editions - Enterprise Plus](../../../includes/incl-supported-OS-Enterprise-Plus.md)] --> [!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)]
Enables or disables settings for Keyboard Filter. Enables or disables settings for Keyboard Filter.