-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Handshake.xml
154 lines (148 loc) · 7.79 KB
/
Handshake.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
153
154
<Type Name="Handshake" FullName="System.IO.Ports.Handshake">
<TypeSignature Language="C#" Value="public enum Handshake" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed Handshake extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.IO.Ports.Handshake" />
<TypeSignature Language="VB.NET" Value="Public Enum Handshake" />
<TypeSignature Language="F#" Value="type Handshake = " />
<TypeSignature Language="C++ CLI" Value="public enum class Handshake" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.IO.Ports</AssemblyName>
<AssemblyVersion>4.0.1.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>
<TypeForwardingChain>
<TypeForwarding From="System.IO.Ports" FromVersion="9.0.0.0" To="System" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This enumeration is used with the <xref:System.IO.Ports.SerialPort.Handshake%2A> property.
## Examples
The following code example displays the possible values of the <xref:System.IO.Ports.Handshake> enumeration to the console, then prompts the user to choose one. This code example is part of a larger code example provided for the <xref:System.IO.Ports.SerialPort> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.Ports.SerialPort/cpp/serialport.cpp" id="Snippet05":::
:::code language="csharp" source="~/snippets/csharp/System.IO.Ports/Handshake/Overview/SerialPort.cs" id="Snippet05":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.Ports.SerialPort/vb/SerialPort.vb" id="Snippet05":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.Handshake None = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.IO.Ports.Handshake.None" />
<MemberSignature Language="VB.NET" Value="None" />
<MemberSignature Language="F#" Value="None = 0" Usage="System.IO.Ports.Handshake.None" />
<MemberSignature Language="C++ CLI" Value="None" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.IO.Ports</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Ports.Handshake</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>No control is used for the handshake.</summary>
</Docs>
</Member>
<Member MemberName="RequestToSend">
<MemberSignature Language="C#" Value="RequestToSend" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.Handshake RequestToSend = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.IO.Ports.Handshake.RequestToSend" />
<MemberSignature Language="VB.NET" Value="RequestToSend" />
<MemberSignature Language="F#" Value="RequestToSend = 2" Usage="System.IO.Ports.Handshake.RequestToSend" />
<MemberSignature Language="C++ CLI" Value="RequestToSend" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.IO.Ports</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Ports.Handshake</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</Docs>
</Member>
<Member MemberName="RequestToSendXOnXOff">
<MemberSignature Language="C#" Value="RequestToSendXOnXOff" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.Handshake RequestToSendXOnXOff = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" />
<MemberSignature Language="VB.NET" Value="RequestToSendXOnXOff" />
<MemberSignature Language="F#" Value="RequestToSendXOnXOff = 3" Usage="System.IO.Ports.Handshake.RequestToSendXOnXOff" />
<MemberSignature Language="C++ CLI" Value="RequestToSendXOnXOff" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.IO.Ports</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Ports.Handshake</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</Docs>
</Member>
<Member MemberName="XOnXOff">
<MemberSignature Language="C#" Value="XOnXOff" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.Handshake XOnXOff = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.IO.Ports.Handshake.XOnXOff" />
<MemberSignature Language="VB.NET" Value="XOnXOff" />
<MemberSignature Language="F#" Value="XOnXOff = 1" Usage="System.IO.Ports.Handshake.XOnXOff" />
<MemberSignature Language="C++ CLI" Value="XOnXOff" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.IO.Ports</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Ports.Handshake</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</Docs>
</Member>
</Members>
</Type>