WEKF_CustomKey.Add

Crée une combinaison de touches personnalisée, et active le filtre clavier pour bloquer la nouvelle combinaison de touches.

Syntaxe

[Static] uint32 Add(
    [In] string CustomKey
);

Paramètres

CustomKey
[in] Combinaison de touches personnalisée à ajouter. Pour obtenir la liste des noms de touches valides, consultez Noms de touches de filtre clavier.

Valeur renvoyée

Retourne une valeur HRESULT qui indique une constante de non-erreur WMI ou une constante d’erreur WMI.

Notes

WEKF_CustomKey.Add crée un objet WEKF_CustomKey, et définit la propriété Enabled du nouvel objet sur true et la propriété Id sur CustomKey.

S’il existe déjà un objet WEKF_CustomKey avec la propriété Id égale à CustomKey, WEKF_CustomKey.Add retourne un code d’erreur et ne crée pas d’objet ou ne modifie pas les propriétés de l’objet existant. Si la propriété Enabled est définie sur false pour l’objet WEKF_CustomKey existant, le filtre clavier ne bloque pas la combinaison de touches personnalisée.

Exemple

Le code suivant montre comment ajouter ou activer une touche personnalisée que le filtre clavier bloquera à l’aide des fournisseurs WMI (Windows Management Instrumentation) pour le filtre clavier.

$COMPUTER = "localhost"
$NAMESPACE = "root\standardcimv2\embedded"

# Create a handle to the class instance so we can call the static methods
$classCustomKey = [wmiclass]"\\$COMPUTER\${NAMESPACE}:WEKF_CustomKey"

# Create a function to add or enable a key combination for Keyboard Filter to block
function Enable-Custom-Key($KeyId) {

# Check to see if the custom key object already exists
    $objCustomKey = Get-WMIObject -namespace $NAMESPACE -class WEKF_CustomKey |
            where {$_.Id -eq "$KeyId"};

    if ($objCustomKey) {

# The custom key already exists, so just enable it
        $objCustomKey.Enabled = 1;
        $objCustomKey.Put() | Out-Null;
        "Enabled ${KeyId}.";

    } else {

# Create a new custom key object by calling the static Add method
        $retval = $classCustomKey.Add($KeyId);

# Check the return value to verify that the Add is successful
        if ($retval.ReturnValue -eq 0) {
            "Added ${KeyID}."
        } else {
            "Unknown Error: " + "{0:x0}" -f $retval.ReturnValue
        }
    }
}

# Enable Keyboard Filter to block several custom keys

Enable-Custom-Key "Ctrl+v"
Enable-Custom-Key "Ctrl+v"
Enable-Custom-Key "Shift+4"
Enable-Custom-Key "Ctrl+Alt+w"

# List all the currently existing custom keys

$objCustomKeyList = get-WMIObject -namespace $NAMESPACE -class WEKF_CustomKey
foreach ($objCustomKeyItem in $objCustomKeyList) {
    "Custom key: " + $objCustomKeyItem.Id
    "   enabled: " + $objCustomKeyItem.Enabled
    }

Spécifications

Rubriques connexes

• WEKF_CustomKey
• Filtre de clavier