Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ReadKeyOptions Enumeration

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Defines the options used to control the behavior of the ReadKey method.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:   System.Management.Automation.Host
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

[FlagsAttribute]
public enum ReadKeyOptions

Member nameDescription
AllowCtrlC

Allow Ctrl-C to be processed as a keystroke, as opposed to causing a break event.

IncludeKeyDown

Include key down events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified.

IncludeKeyUp

Include key up events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified.

NoEcho

Do not display the character for the key in the window when pressed.

Either IncludeKeyDown, IncludeKeyUp, or both must be specified in a call to the ReadKey method.

Return to top
Show: