ReadKeyOptions Enum

  • Reference

Definition

Namespace:
System.Management.Automation.Host
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Governs the behavior of ReadKey() and ReadKey(ReadKeyOptions)

This enumeration supports a bitwise combination of its member values.

public enum class ReadKeyOptions
[System.Flags]
public enum ReadKeyOptions
[<System.Flags>]
type ReadKeyOptions = 
Public Enum ReadKeyOptions
Inheritance
Enum
ReadKeyOptions
Attributes
FlagsAttribute

Fields

AllowCtrlC 1

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

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

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

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

Applies to