-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SafeSocketHandle.xml
138 lines (135 loc) · 7.54 KB
/
SafeSocketHandle.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
<Type Name="SafeSocketHandle" FullName="System.Net.Sockets.SafeSocketHandle">
<TypeSignature Language="C#" Value="public sealed class SafeSocketHandle : Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SafeSocketHandle extends Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid" />
<TypeSignature Language="DocId" Value="T:System.Net.Sockets.SafeSocketHandle" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SafeSocketHandle
Inherits SafeHandleMinusOneIsInvalid" />
<TypeSignature Language="F#" Value="type SafeSocketHandle = class
 inherit SafeHandleMinusOneIsInvalid" />
<TypeSignature Language="C++ CLI" Value="public ref class SafeSocketHandle sealed : Microsoft::Win32::SafeHandles::SafeHandleMinusOneIsInvalid" />
<AssemblyInfo>
<AssemblyName>System.Net.Sockets</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<Base>
<BaseTypeName>Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a wrapper class for a socket handle.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is derived from <xref:Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid>. A value of 0 or -1 is an invalid socket handle.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SafeSocketHandle ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Sockets.SafeSocketHandle.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SafeSocketHandle();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Sockets</AssemblyName>
<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>
<Parameters />
<Docs>
<summary>Creates a <see cref="T:System.Net.Sockets.SafeSocketHandle" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SafeSocketHandle (IntPtr preexistingHandle, bool ownsHandle);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int preexistingHandle, bool ownsHandle) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Sockets.SafeSocketHandle.#ctor(System.IntPtr,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (preexistingHandle As IntPtr, ownsHandle As Boolean)" />
<MemberSignature Language="F#" Value="new System.Net.Sockets.SafeSocketHandle : nativeint * bool -> System.Net.Sockets.SafeSocketHandle" Usage="new System.Net.Sockets.SafeSocketHandle (preexistingHandle, ownsHandle)" />
<MemberSignature Language="C++ CLI" Value="public:
 SafeSocketHandle(IntPtr preexistingHandle, bool ownsHandle);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Sockets</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<Parameters>
<Parameter Name="preexistingHandle" Type="System.IntPtr" />
<Parameter Name="ownsHandle" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="preexistingHandle">The pre-existing handle to use.</param>
<param name="ownsHandle">
<see langword="true" /> to reliably release the handle during the finalization phase; <see langword="false" /> to prevent reliable release (not recommended).</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.SafeSocketHandle" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsInvalid">
<MemberSignature Language="C#" Value="public override bool IsInvalid { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsInvalid" />
<MemberSignature Language="DocId" Value="P:System.Net.Sockets.SafeSocketHandle.IsInvalid" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property IsInvalid As Boolean" />
<MemberSignature Language="F#" Value="member this.IsInvalid : bool" Usage="System.Net.Sockets.SafeSocketHandle.IsInvalid" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool IsInvalid { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Sockets</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the handle value is invalid.</summary>
<value>
<see langword="true" /> if the handle value is invalid; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReleaseHandle">
<MemberSignature Language="C#" Value="protected override bool ReleaseHandle ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool ReleaseHandle() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Sockets.SafeSocketHandle.ReleaseHandle" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function ReleaseHandle () As Boolean" />
<MemberSignature Language="F#" Value="override this.ReleaseHandle : unit -> bool" Usage="safeSocketHandle.ReleaseHandle " />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool ReleaseHandle();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Sockets</AssemblyName>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>