Set-PSReadLineKeyHandler
Lie des clés à des fonctions de gestionnaire de clés définies par l’utilisateur ou PSReadLine.
Syntax
Set-PSReadLineKeyHandler
[-ScriptBlock] <ScriptBlock>
[-BriefDescription <String>]
[-Description <String>]
[-Chord] <String[]>
[-ViMode <ViMode>]
[<CommonParameters>]
Set-PSReadLineKeyHandler
[-Chord] <String[]>
[-ViMode <ViMode>]
[-Function] <String>
[<CommonParameters>]
Description
L’applet Set-PSReadLineKeyHandler
de commande personnalise le résultat lorsqu’une touche ou une séquence de touches est enfoncée. Avec les liaisons de clés définies par l’utilisateur, vous pouvez faire presque tout ce qui est possible à partir d’un script PowerShell.
Exemples
Exemple 1 : Lier la touche de direction à une fonction
Cette commande lie la flèche haut à la fonction HistorySearchBackward . Cette fonction recherche dans l’historique des commandes des lignes de commande qui commencent par le contenu actuel de la ligne de commande.
Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward
Exemple 2 : Lier une clé à un bloc de script
Cet exemple montre comment utiliser une clé unique pour exécuter une commande. La commande lie la clé Ctrl+B
à un bloc de script qui efface la ligne, insère le mot « build », puis accepte la ligne.
Set-PSReadLineKeyHandler -Chord Ctrl+B -ScriptBlock {
[Microsoft.PowerShell.PSConsoleReadLine]::RevertLine()
[Microsoft.PowerShell.PSConsoleReadLine]::Insert('build')
[Microsoft.PowerShell.PSConsoleReadLine]::AcceptLine()
}
Paramètres
-BriefDescription
Brève description de la liaison de clé. Cette description est affichée par l’applet de Get-PSReadLineKeyHandler
commande.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Chord
Clé ou séquence de clés à lier à une fonction ou à un bloc de script. Utilisez une chaîne unique pour spécifier une liaison unique. Si la liaison est une séquence de clés, séparez les clés par une virgule, comme dans l’exemple suivant :
Ctrl+X,Ctrl+L
Notes
À partir de PSReadLine 2.0.0, le paramètre Chordrespecte la casse. Autrement dit, Ctrl+X et Ctrl+x créent des liaisons différentes.
Ce paramètre accepte un tableau de chaînes. Chaque chaîne est une liaison distincte, et non une séquence de clés pour une seule liaison.
Type: | String[] |
Aliases: | Key |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Spécifie une description plus détaillée de la liaison de clé visible dans la sortie de l’applet Get-PSReadLineKeyHandler
de commande.
Type: | String |
Aliases: | LongDescription |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Function
Spécifie le nom d’un gestionnaire de clés existant fourni par PSReadLine. Ce paramètre vous permet de lier à nouveau des liaisons de clés existantes ou de lier un gestionnaire actuellement non lié.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScriptBlock
Spécifie une valeur de bloc de script à exécuter lorsque l’accord est entré. PSReadLine transmet un ou deux paramètres à ce bloc de script. Le premier paramètre est un objet ConsoleKeyInfo représentant la touche enfoncée. Le deuxième argument peut être n’importe quel objet en fonction du contexte.
Type: | ScriptBlock |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ViMode
Spécifiez le mode vi auquel la liaison s’applique.
Les valeurs autorisées sont :
Insert
Command
Type: | ViMode |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
None
Vous ne pouvez pas rediriger des objets vers cette applet de commande.
Sorties
None
Cette applet de commande ne génère aucune sortie.