Edit

Share via


Remove-PSReadLineKeyHandler

Removes a key binding.

Syntax

Default (Default)

Remove-PSReadLineKeyHandler
    [-Chord] <String[]>
    [-ViMode <ViMode>]
    [<CommonParameters>]

Description

The Remove-PSReadLineKeyHandler cmdlet removes a specified key binding.

Examples

Example 1: Remove a binding

Remove-PSReadLineKeyHandler -Chord Ctrl+B

This command removes the binding from the key combination, or chord, Ctrl+B. The Ctrl+B chord is created in the Set-PSReadLineKeyHandler article.

Parameters

-Chord

Specifies an array of keys or sequences of keys to be removed. A single binding is specified by using a single string. If the binding is a sequence of keys, separate the keys by a comma, as in the following example:

Ctrl+x,Ctrl+l

This parameter accepts an array of strings. Each string is a separate binding, not a sequence of keys for a single binding.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Key

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ViMode

Specify which vi mode the binding applies to. Possible values are: Insert, Command.

Parameter properties

Type:ViMode
Default value:None
Accepted values:Insert, Command
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can't pipe objects to this cmdlet.

Outputs

None

This cmdlet returns no output.