-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathConsoleSpecialKey.xml
152 lines (145 loc) · 8.47 KB
/
ConsoleSpecialKey.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<Type Name="ConsoleSpecialKey" FullName="System.ConsoleSpecialKey">
<TypeSignature Language="C#" Value="public enum ConsoleSpecialKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed ConsoleSpecialKey extends System.Enum" FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netstandard-1.3;netstandard-1.4;netstandard-1.6;netstandard-2.0;netstandard-2.1" />
<TypeSignature Language="DocId" Value="T:System.ConsoleSpecialKey" />
<TypeSignature Language="VB.NET" Value="Public Enum ConsoleSpecialKey" />
<TypeSignature Language="F#" Value="type ConsoleSpecialKey = " />
<TypeSignature Language="C++ CLI" Value="public enum class ConsoleSpecialKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed ConsoleSpecialKey extends System.Enum" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<AssemblyInfo>
<AssemblyName>System.Console</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Console" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Console" ToVersion="6.0.0.0" FrameworkAlternate="net-6.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Console" ToVersion="7.0.0.0" FrameworkAlternate="net-7.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Console" ToVersion="8.0.0.0" FrameworkAlternate="net-8.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Console" ToVersion="9.0.0.0" FrameworkAlternate="net-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies combinations of modifier and console keys that can interrupt the current process.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.ConsoleCancelEventArgs.SpecialKey%2A?displayProperty=nameWithType> property returns the <xref:System.ConsoleSpecialKey> enumeration type.
Simultaneously pressing certain key combinations signals the operating system to interrupt the currently running process. The two valid key combinations are <xref:System.ConsoleModifiers.Control?displayProperty=nameWithType> plus BREAK (CTRL+BREAK) and <xref:System.ConsoleModifiers.Control?displayProperty=nameWithType> plus <xref:System.ConsoleKey.C?displayProperty=nameWithType> (CTRL+C).
## Examples
The following code example displays the <xref:System.ConsoleSpecialKey> value that invokes the associated event handler.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/console.cancelkeypress/cpp/ckp.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System/Console/CancelKeyPress/ckp.cs" id="Snippet1":::
:::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR/console.cancelkeypress/fs/ckp.fs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/console.cancelkeypress/vb/ckp.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.ConsoleCancelEventArgs" />
</Docs>
<Members>
<Member MemberName="ControlBreak">
<MemberSignature Language="C#" Value="ControlBreak" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.ConsoleSpecialKey ControlBreak = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.ConsoleSpecialKey.ControlBreak" />
<MemberSignature Language="VB.NET" Value="ControlBreak" />
<MemberSignature Language="F#" Value="ControlBreak = 1" Usage="System.ConsoleSpecialKey.ControlBreak" />
<MemberSignature Language="C++ CLI" Value="ControlBreak" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Console</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ConsoleSpecialKey</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The <see cref="F:System.ConsoleModifiers.Control" /> modifier key plus the BREAK console key.</summary>
</Docs>
</Member>
<Member MemberName="ControlC">
<MemberSignature Language="C#" Value="ControlC" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.ConsoleSpecialKey ControlC = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.ConsoleSpecialKey.ControlC" />
<MemberSignature Language="VB.NET" Value="ControlC" />
<MemberSignature Language="F#" Value="ControlC = 0" Usage="System.ConsoleSpecialKey.ControlC" />
<MemberSignature Language="C++ CLI" Value="ControlC" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Console</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ConsoleSpecialKey</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>The <see cref="F:System.ConsoleModifiers.Control" /> modifier key plus the <see cref="F:System.ConsoleKey.C" /> console key.</summary>
</Docs>
</Member>
</Members>
</Type>