From 6ac5e2f71bbdb38eae47e949e0fd9cf985513d98 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 21 May 2026 20:20:27 -0700 Subject: [PATCH 1/5] remove .net fw remarks --- xml/System.Net.Cache/HttpCacheAgeControl.xml | 4 +- .../HttpRequestCacheLevel.xml | 12 +- .../HttpRequestCachePolicy.xml | 18 +- xml/System.Net.Cache/RequestCacheLevel.xml | 5 +- xml/System.Net.Cache/RequestCachePolicy.xml | 13 +- xml/System.Net.Http/HttpClient.xml | 434 +++++------------- xml/System.Net.Http/HttpClientHandler.xml | 12 +- xml/System.Net.Http/HttpResponseMessage.xml | 4 +- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- xml/System.Net.Http/WinHttpHandler.xml | 3 +- xml/System.Net.Mail/MailMessage.xml | 13 +- xml/System.Net.Mail/SmtpAccess.xml | 16 +- xml/System.Net.Mail/SmtpClient.xml | 142 +----- xml/System.Net.Mail/SmtpPermission.xml | 103 +---- .../SmtpPermissionAttribute.xml | 33 +- .../NetworkChange.xml | 2 +- .../NetworkInformationPermission.xml | 103 +---- .../NetworkInformationPermissionAttribute.xml | 41 +- .../PhysicalAddress.xml | 18 +- xml/System.Net.NetworkInformation/Ping.xml | 4 - .../PeerCollaborationPermission.xml | 106 +---- .../PeerCollaborationPermissionAttribute.xml | 26 +- xml/System.Net.PeerToPeer/PnrpPermission.xml | 131 +----- .../PnrpPermissionAttribute.xml | 22 +- .../SslClientAuthenticationOptions.xml | 2 +- xml/System.Net.Security/SslStream.xml | 19 +- xml/System.Net.Sockets/IPProtectionLevel.xml | 11 +- xml/System.Net.Sockets/Socket.xml | 354 +------------- .../SocketAsyncEventArgs.xml | 6 - xml/System.Net.Sockets/SocketFlags.xml | 2 +- xml/System.Net.Sockets/TcpClient.xml | 116 +---- xml/System.Net.Sockets/TcpListener.xml | 63 +-- xml/System.Net.WebSockets/WebSocket.xml | 4 +- 33 files changed, 222 insertions(+), 1622 deletions(-) diff --git a/xml/System.Net.Cache/HttpCacheAgeControl.xml b/xml/System.Net.Cache/HttpCacheAgeControl.xml index e37a41f810d..7a342cee19b 100644 --- a/xml/System.Net.Cache/HttpCacheAgeControl.xml +++ b/xml/System.Net.Cache/HttpCacheAgeControl.xml @@ -53,7 +53,7 @@ ## Examples The following code example creates a policy based on MaxAgeAndMinFresh. - + :::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet9"::: ]]> @@ -300,7 +300,7 @@ 0 - For internal use only. The Framework will throw an if you try to use this member. + For internal use only.An is thrown if you try to use this member. diff --git a/xml/System.Net.Cache/HttpRequestCacheLevel.xml b/xml/System.Net.Cache/HttpRequestCacheLevel.xml index eb7c6d38432..b2259c3c3fa 100644 --- a/xml/System.Net.Cache/HttpRequestCacheLevel.xml +++ b/xml/System.Net.Cache/HttpRequestCacheLevel.xml @@ -49,25 +49,15 @@ ## Remarks This enumeration is used to set the cache level specified by objects. - This `BypassCache` value is the default cache behavior specified in the machine configuration file that ships with the .NET Framework. No entries are taken from caches, added to caches, or removed from caches between the client and server. - The property is used to get or set the default cache policy for instances. The property is used to get or set the default cache policy for a instance. The property is used to get or set the cache policy for a specific request. A copy of a resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So another request for the same resource could use a cached copy, depending on the default cache policy level for this request. - - -## Examples - The following code example sets the application domain's caching policy to Default. - - :::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet2"::: - ]]> Cache Management for Network Applications - RequestCaching Element (Network Settings) @@ -107,7 +97,7 @@ 1 - Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. No entries are taken from caches, added to caches, or removed from caches between the client and server. This is the default cache behavior specified in the machine configuration file that ships with the .NET Framework. + Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. No entries are taken from caches, added to caches, or removed from caches between the client and server. diff --git a/xml/System.Net.Cache/HttpRequestCachePolicy.xml b/xml/System.Net.Cache/HttpRequestCachePolicy.xml index a82f85978d5..78169a27592 100644 --- a/xml/System.Net.Cache/HttpRequestCachePolicy.xml +++ b/xml/System.Net.Cache/HttpRequestCachePolicy.xml @@ -48,19 +48,12 @@ property or the application or machine configuration files. For more information, see [<requestCaching> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings). + You can specify a default cache policy for your application by using the property. You can specify the cache policy for an individual request by using the property. Caching for Web services is not supported. - - -## Examples - The following code example creates a default cache policy for the application domain, and overrides it for a request. - - :::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet2"::: - ]]> Cache Management for Network Applications @@ -527,14 +520,7 @@ as their cache policy level. The property, if not `null`, determines the cache policy in effect for a request. The default policy for the application domain can be set using the property or by settings in the machine or application configuration files. For more information, see [<requestCaching> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings). - - - -## Examples - The following code example demonstrates displaying the value of this property. - - :::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet11"::: + Applications typically use as their cache policy level. The property, if not `null`, determines the cache policy in effect for a request. The default policy can be set using the property. ]]> diff --git a/xml/System.Net.Cache/RequestCacheLevel.xml b/xml/System.Net.Cache/RequestCacheLevel.xml index 0dad264554d..a9983b43f33 100644 --- a/xml/System.Net.Cache/RequestCacheLevel.xml +++ b/xml/System.Net.Cache/RequestCacheLevel.xml @@ -49,8 +49,6 @@ ## Remarks Members of this enumeration are used to initialize objects. The current setting for a object is available in the property. - This value is the default cache behavior specified in the machine configuration file that ships with the .NET Framework. No entries are taken from caches, added to caches, or removed from caches between the client and server. - The property is used to get or set the default cache policy for instances. The property is used to get or set the default cache policy for a instances. The property is used to get or set the cache policy for a specific request. If the cache behavior is `CacheIfAvailable` or `Revalidate`, a copy of a requested resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. With `CacheIfAvailable`, subsequent requests for the same resource would use a cached copy. With `Revalidate`, subsequent requests for the same resource would use a cached copy if the timestamp for the cached resource is the same as the timestamp of the resource on the server. @@ -67,7 +65,6 @@ A copy of a resource is only added to the cache if the response stream for the r Cache Management for Network Applications - RequestCaching Element (Network Settings) @@ -107,7 +104,7 @@ A copy of a resource is only added to the cache if the response stream for the r 1 - Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. This is the default cache behavior specified in the machine configuration file that ships with the .NET Framework. + Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. diff --git a/xml/System.Net.Cache/RequestCachePolicy.xml b/xml/System.Net.Cache/RequestCachePolicy.xml index d59afeaf0e9..61a85096d39 100644 --- a/xml/System.Net.Cache/RequestCachePolicy.xml +++ b/xml/System.Net.Cache/RequestCachePolicy.xml @@ -48,14 +48,12 @@ property or the application or machine configuration files. For more information, see [<requestCaching> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings). + You can specify a default cache policy for your application by using the property. You can specify the cache policy for an individual request by using the property. Caching for Web services is not supported. - - ## Examples The following code example creates a policy with set to , and uses it to set the cache policy of a . @@ -231,14 +229,7 @@ ## Remarks Applications typically use as their cache policy level. Using the level, the effective cache policy is determined by the current cache policy and the age of the content in the cache. The property, if not `null`, determines the cache policy in effect for a request. - The default policy for the application domain can be set using the or the application or machine configuration file. For more information, see [<requestCaching> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings). - - - -## Examples - The following code example creates a policy and sends a request. - - :::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet13"::: +You can set the default policy using the property. ]]> diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index a1003059876..4e92e3056b1 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -589,11 +589,7 @@ This property has no effect on any of the object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations: -> -> - that nests a is thrown on .NET 5 and later versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - is thrown on all applicable .NET Framework versions. +> In case of timeout, that nests a is thrown. ]]> The request message was already sent by the instance. @@ -605,12 +601,8 @@ The is not an absolute URI. -or- is not set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by . - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by . + The request failed due to timeout. @@ -666,11 +658,7 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations: -> -> - that nests a is thrown on .NET 5 and later versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - is thrown on all applicable .NET Framework versions. +> In case of timeout, that nests a is thrown. ]]> The request message was already sent by the instance. @@ -682,12 +670,8 @@ The is not an absolute URI. -or- is not set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -749,11 +733,7 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> -> - that nests a is thrown on .NET 5 and later versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - is thrown on all applicable .NET Framework versions. +> In case of timeout, that nests a is thrown. ]]> The request message was already sent by the instance. @@ -765,16 +745,12 @@ The is not an absolute URI. -or- is not set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -832,11 +808,7 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. - -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The request message was already sent by the instance. @@ -848,16 +820,12 @@ The is not an absolute URI. -or- is not set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -988,19 +956,12 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -1057,19 +1018,12 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -1131,15 +1085,12 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -1202,24 +1153,17 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The provided request URI is not valid relative or absolute URI. The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1277,19 +1221,12 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -1347,23 +1284,16 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - TThe request failed due to an issue getting an HTTP response such as network connectivity, DNS failure or server certificate validation. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + TThe request failed due to an issue getting an HTTP response such as network connectivity, DNS failure or server certificate validation. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1427,24 +1357,17 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The provided request URI is not valid relative or absolute URI. The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1504,23 +1427,16 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1601,10 +1517,7 @@ The is not an absolute URI. In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. @@ -1612,12 +1525,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -1676,10 +1585,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, that nests a is thrown. ]]> @@ -1688,12 +1594,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. @@ -1749,10 +1651,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, that nests a is thrown. ]]> @@ -1766,7 +1665,7 @@ The response status code was outside of the range of 200-299 (which indicate suc -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1818,10 +1717,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, that nests a is thrown. ]]> @@ -1835,7 +1731,7 @@ The response status code was outside of the range of 200-299 (which indicate suc -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -1916,10 +1812,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. @@ -1927,12 +1820,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -1991,10 +1880,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, that nests a is thrown. ]]> The is not an absolute URI and isn't set. @@ -2002,12 +1888,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. @@ -2063,17 +1945,14 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws an without any inner exception. -> - .NET 5 and later versions throw an that nests a . +> In case of a timeout: an that nests a is thrown. ]]> The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. The is . The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by @@ -2132,10 +2011,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, an that nests a is thrown. ]]> The is . @@ -2148,7 +2024,7 @@ The response status code was outside of the range of 200-299 (which indicate suc -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -2229,10 +2105,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. @@ -2240,12 +2113,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -2304,10 +2173,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. @@ -2315,12 +2181,8 @@ In some scenarios, you might need more control over which status codes are consi -or- -The response status code was outside of the range of 200-299 (which indicate success according to the standard). - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. +The response status code was outside of the range of 200-299 (which indicate success according to the standard). + The request failed due to timeout. @@ -2376,10 +2238,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, an that nests a is thrown. ]]> The is . @@ -2393,7 +2252,7 @@ The response status code was outside of the range of 200-299 (which indicate suc -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -2445,10 +2304,7 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: -> - .NET Framework throws a . -> - .NET Core throws a without any inner exception. -> - .NET 5 and later versions throw a that nests a . +> In case of a timeout, an that nests a is thrown. ]]> The is . @@ -2461,7 +2317,7 @@ The response status code was outside of the range of 200-299 (which indicate suc -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -2843,19 +2699,12 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -2914,19 +2763,12 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -2993,24 +2835,17 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The provided request URI is not valid relative or absolute URI. The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3070,23 +2905,16 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3170,19 +2998,12 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. The provided request URI is not valid relative or absolute URI. @@ -3241,19 +3062,12 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -3320,24 +3134,17 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The provided request URI is not valid relative or absolute URI. The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3397,23 +3204,16 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. ]]> The is not an absolute URI and isn't set. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3618,7 +3418,7 @@ The custom does not override -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3691,7 +3491,7 @@ The custom does not override -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3758,10 +3558,7 @@ The custom does not override This operation doesn't block. The returned object will complete once the entire response including content is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3769,12 +3566,8 @@ This method stores in the task it returns all non-usage exceptions that the meth The is . The request message was already sent by the instance. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -3824,10 +3617,7 @@ This method stores in the task it returns all non-usage exceptions that the meth This operation doesn't block. Depending on the value of the `completionOption` parameter, the returned object will complete as soon as a response is available or the entire response including content is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3835,12 +3625,8 @@ This method stores in the task it returns all non-usage exceptions that the meth The is . The request message was already sent by the instance. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. - .NET Core and .NET 5 and later only: The request failed due to timeout. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by + The request failed due to timeout. @@ -3890,10 +3676,7 @@ This method stores in the task it returns all non-usage exceptions that the meth This operation doesn't block. The returned object will complete once the entire response including content is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3901,16 +3684,12 @@ This method stores in the task it returns all non-usage exceptions that the meth The is . The request message was already sent by the instance. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: The request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. @@ -3962,10 +3741,7 @@ This method stores in the task it returns all non-usage exceptions that the meth This operation doesn't block. Depending on the value of the `completionOption` parameter, the returned object will complete as soon as a response is available or the entire response including content is read. > [!NOTE] -> In case of timeout, different exceptions are thrown on different .NET implementations. -> - is thrown on all applicable .NET Framework versions. -> - without any inner exception is thrown on all applicable .NET Core versions. -> - that nests a is thrown on .NET 5 and later versions. +> In case of timeout, an that nests a is thrown. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3973,16 +3749,12 @@ This method stores in the task it returns all non-usage exceptions that the meth The is . The request message was already sent by the instance. - The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by - --or- - -.NET Framework only: the request timed out. + The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by The cancellation token was canceled. This exception is stored into the returned task. -or- -.NET Core and .NET 5 and later only: The request failed due to timeout. +The request failed due to timeout. diff --git a/xml/System.Net.Http/HttpClientHandler.xml b/xml/System.Net.Http/HttpClientHandler.xml index 2cac07b770e..7bb75c963e0 100644 --- a/xml/System.Net.Http/HttpClientHandler.xml +++ b/xml/System.Net.Http/HttpClientHandler.xml @@ -129,15 +129,14 @@ ## Remarks Set to `true` if you want the handler to automatically follow HTTP redirection headers to the new location of the resource. The maximum number of redirections to follow is set by the property. - If is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application. + If is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application. The Authorization header is cleared on auto-redirects and the handler automatically tries to re-authenticate to the redirected location. No other headers are cleared. In practice, this means that an application can't put custom authentication information into the Authorization header if it is possible to encounter redirection. Instead, the application must implement and register a custom authentication module. If you are using cookies by specifically adding them to the collection, these are not cleared when a redirect is followed, as the handler has no way of knowing what domain a cookie is allowed for. If you want to mimic browser behavior, use the class which allows you to specify the target domain for a cookie. > [!NOTE] -> On .NET Core and .NET 5 and later versions, setting to `true` **does not enable** automatic redirection to an HTTP URI from an HTTPS URI. -> Such (secure to insecure) redirections are only followed on .NET Framework. +> Setting to `true` **does not enable** automatic redirection to an HTTP URI from an HTTPS URI. ]]> @@ -192,9 +191,6 @@ Setting automatic decompression to anything other than will result in adding `Accept-Encoding` header with the set values into every outgoing . - -For the .NET Framework 4.x `System.Net.Http` binary in the Global Assembly Cache (GAC), the default value is . - ]]> @@ -241,7 +237,6 @@ For the .NET Framework 4.x `System.Net.Http` binary in the Global Assembly Cache if the certificate revocation list is checked; otherwise, . To be added. - .NET Framework 4.7.1 only: This property is not implemented. @@ -330,7 +325,7 @@ For the .NET Framework 4.x `System.Net.Http` binary in the Global Assembly Cache ## Remarks -On .NET Core, the key usage attribute on the X509 certificate, if present, is required to have the value "Digital Signature" in order to be used when sending the request. +The key usage attribute on the X509 certificate, if present, is required to have the value "Digital Signature" in order to be used when sending the request. ]]> @@ -1210,7 +1205,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA Gets or sets the TLS/SSL protocols used by the objects managed by the HttpClientHandler object. A bitwise combination of the enumeration values that specify the TLS/SSL protocols. To be added. - .NET Framework 4.7.1 only: This property is not implemented. diff --git a/xml/System.Net.Http/HttpResponseMessage.xml b/xml/System.Net.Http/HttpResponseMessage.xml index 6fe1503ce54..8f3687ffcf1 100644 --- a/xml/System.Net.Http/HttpResponseMessage.xml +++ b/xml/System.Net.Http/HttpResponseMessage.xml @@ -354,10 +354,8 @@ When the `disposing` parameter is `true`, this method releases all resources hel ## Remarks The method throws an if is outside of the range 200-299 (the range of status codes indicating success according to the standard). - - In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. - In .NET Framework, if the is not `null`, this method also calls to free managed and unmanaged resources. Starting with .NET Core 3.0, the content is not disposed. + In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. ]]> diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 0b08b1a988a..16252503ce1 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -949,7 +949,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r Gets or sets how long a connection can be idle in the pool to be considered reusable. - The maximum idle time for a connection in the pool. The default value for this property is 1 minute in .NET 6 and later versions; the default value is 2 minutes in .NET Core and .NET 5 + The maximum idle time for a connection in the pool. The default value is 1 minute. To be added. The value specified is less than and is not . An operation has already been started on the current instance. diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index b31b069c32f..3134067bd77 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -60,8 +60,7 @@ Starting in .NET 5, is no longer included Starting with version 6.0.0, supports trailing headers, also known as trailers ([RFC 7230 - 4.1.2. Chunked Trailer Part](https://tools.ietf.org/html/rfc7230#section-4.1.2)). -- On .NET Standard 2.1 and .NET 8 or later, trailers are added to . -- On .NET Framework, trailers are added to a well-known property in on the request object corresponding to the response (). The name of the property is `__ResponseTrailers`, the type of the property value is . +Trailers are added to . Trailer support is implemented via the `WINHTTP_QUERY_FLAG_TRAILERS` [Query Info Flag](/windows/win32/winhttp/query-info-flags) which has been introduced in Windows 11, version 21H2 (10.0; Build 22000). On Windows systems where `WINHTTP_QUERY_FLAG_TRAILERS` is unsupported, trailers are ignored. diff --git a/xml/System.Net.Mail/MailMessage.xml b/xml/System.Net.Mail/MailMessage.xml index 235f7fde750..7386748805a 100644 --- a/xml/System.Net.Mail/MailMessage.xml +++ b/xml/System.Net.Mail/MailMessage.xml @@ -162,14 +162,7 @@ Initializes an empty instance of the class. - - - + To be added. @@ -691,9 +684,7 @@ ## Remarks The value specified for the property sets the character set field in the Content-Type header. The default character set is `"us-ascii"`. - If you set the property to , , or , the Framework selects a of for this . - - + If you set the property to , , or , .NET selects a of for this . ## Examples The following code example demonstrates creating a mail message that uses UTF8 encoding. diff --git a/xml/System.Net.Mail/SmtpAccess.xml b/xml/System.Net.Mail/SmtpAccess.xml index 342a6fa327e..95082543b08 100644 --- a/xml/System.Net.Mail/SmtpAccess.xml +++ b/xml/System.Net.Mail/SmtpAccess.xml @@ -36,21 +36,7 @@ Specifies the level of access allowed to a Simple Mail Transport Protocol (SMTP) server. - - enumeration is used by the and classes to specify a level of access to an SMTP host computer. The class demands an when sending electronic mail to the SMTP host for delivery. - - - -## Examples - The following code example uses the enumeration to create a permission object. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/SmtpAccess/Overview/mailpermissions.cs" id="Snippet1"::: - - ]]> - + To be added. diff --git a/xml/System.Net.Mail/SmtpClient.xml b/xml/System.Net.Mail/SmtpClient.xml index 70e41926ae6..9e65fa7273b 100644 --- a/xml/System.Net.Mail/SmtpClient.xml +++ b/xml/System.Net.Mail/SmtpClient.xml @@ -66,12 +66,6 @@ The `SmtpClient` class is used to send email to an SMTP server for delivery. The > [!IMPORTANT] > We don't recommend that you use the `SmtpClient` class for new development because `SmtpClient` doesn't support many modern protocols. Use [MailKit](https://github.com/jstedfast/MailKit) or other libraries instead. For more information, see [SmtpClient shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0005.md). -The `SmtpClient` class is: - -- Included in .NET Standard 2.0 and later versions and therefore must be part of any .NET implementation that supports those versions. -- Present and can be used in .NET Framework 4 through .NET Framework 4.8. -- Usable in .NET (Core), but its use isn't recommended. - The classes shown in the following table are used to construct email messages that can be sent using . | Class | Description | @@ -90,7 +84,7 @@ The classes shown in the following table are used to construct email messages th To include an attachment with an email message, first create the attachment by using the class, and then add it to the message by using the property. Depending on the email reader used by the recipients and the file type of the attachment, some recipients might not be able to read the attachment. For clients that cannot display the attachment in its original form, you can specify alternate views by using the property. - In .NET Framework, you can use the application or machine configuration files to specify default host, port, and credentials values for all objects. For more information, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). .NET Core does not support setting defaults. As a workaround, you must set the relevant properties on directly. +To specify host, port, and credentials values for all objects, set the relevant properties on directly. To send the email message and block while waiting for the email to be transmitted to the SMTP server, use one of the synchronous methods. To allow your program's main thread to continue executing while the email is transmitted, use one of the asynchronous methods. The event is raised when a operation completes. To receive this event, you must add a delegate to . The delegate must reference a callback method that handles notification of events. To cancel an asynchronous email transmission, use the method. @@ -117,10 +111,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> - Network Programming in the .NET Framework - Network Programming Samples - Network Tracing in the .NET Framework - Security in Network Programming @@ -166,24 +156,8 @@ The following code example demonstrates sending an email message asynchronously. - Initializes a new instance of the class by using configuration file settings. - - , , and properties for the new by using the settings in the application or machine configuration files. For more information, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). - - - -## Examples - The following code example demonstrates sending an email message. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/Attachment/Overview/mail.cs" id="Snippet4"::: - - For an example of the \ node in the application or machine configuration file, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). - - ]]> - + Initializes a new instance of the class using the default port. + To be added. @@ -225,23 +199,7 @@ The following code example demonstrates sending an email message asynchronously. A that contains the name or IP address of the host computer used for SMTP transactions. Initializes a new instance of the class that sends email by using the specified SMTP server. - - property. The and properties are initialized by using the settings in the application or machine configuration files. If `host` is `null` or equal to , is initialized using the settings in the application or machine configuration files. - - For more information about using the application and machine configuration files, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). If information is specified using constructors or properties, this information overrides the configuration file settings. - - - -## Examples - The following code example demonstrates calling this constructor. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/Attachment/Overview/mail.cs" id="Snippet3"::: - - ]]> - + To be added. @@ -285,23 +243,7 @@ The following code example demonstrates sending an email message asynchronously. A that contains the name or IP address of the host used for SMTP transactions. An greater than zero that contains the port to be used on . Initializes a new instance of the class that sends email by using the specified SMTP server and port. - - and properties, respectively. If `host` is `null` or equal to , is initialized using the settings in the application or machine configuration files. If `port` is zero, is initialized using the settings in the application or machine configuration files. The property is initialized using the settings in the application or machine configuration files. - - For more information about using the application and machine configuration files, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). If information is specified using constructors or properties, this information overrides the configuration file settings. - - - -## Examples - The following code example demonstrates calling this constructor. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/Attachment/Overview/mail.cs" id="Snippet1"::: - - ]]> - + To be added. cannot be less than zero. @@ -348,7 +290,7 @@ The following code example demonstrates sending an email message asynchronously. System.Security.Cryptography.X509Certificates.X509CertificateCollection - Specify which certificates should be used to establish the Secure Sockets Layer (SSL) connection. + Gets the certificates that should be used to establish the Secure Sockets Layer (SSL) connection. An , holding one or more client certificates. The default value is derived from the mail configuration attributes in a configuration file. [!NOTE] -> The Framework caches SSL sessions as they are created and attempts to reuse a cached session for a new request, if possible. When attempting to reuse an SSL session, the Framework uses the first element of (if there is one), or tries to reuse an anonymous sessions if is empty. - - +> .NET caches SSL sessions as they are created and attempts to reuse a cached session for a new request, if possible. When attempting to reuse an SSL session, .NET uses the first element of (if there is one), or tries to reuse an anonymous sessions if is empty. ## Examples The following code example establishes an SSL connection with the SMTP server and uses the connection to send an email. @@ -368,7 +308,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> - MailSettings Element (Network Settings) @@ -409,19 +348,15 @@ The following code example demonstrates sending an email message asynchronously. Gets or sets the credentials used to authenticate the sender. - An that represents the credentials to use for authentication; or if no credentials have been specified. + The credentials to use for authentication; or if no credentials have been specified. to `true` instead of setting this property. If the property is set to `false,` then the value set in the property will be used for the credentials when connecting to the server. If the property is set to `false` and the property has not been set, then mail is sent to the server anonymously. - Credentials information can also be specified using the application and machine configuration files. For more information, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). If information is specified using the property, this information overrides the configuration file settings. - > [!CAUTION] -> If you provide credentials for basic authentication, they are sent to the server in clear text. This can present a security issue because your credentials can be seen, and then used by others. - - +> If you provide credentials for basic authentication, they are sent to the server in clear text. This can present a security issue because your credentials can be seen and used by others. ## Examples The following code example demonstrates setting the credentials used to send an email. @@ -527,8 +462,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> - <mailSettings> Element (Network Settings) - <smtp> Element (Network Settings) @@ -755,9 +688,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> - <mailSettings> Element (Network Settings) - <smtp> Element (Network Settings) - <network> Element (Network Settings) @@ -799,30 +729,11 @@ The following code example demonstrates sending an email message asynchronously. Gets or sets the name or IP address of the host used for SMTP transactions. A that contains the name or IP address of the computer to use for SMTP transactions. - - property can also be set using constructors or the application or machine configuration file. For more information, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). - - If information is specified using this property, this information overrides the configuration file settings. - - - -## Examples - The following code example demonstrates sending an email message by using the host and port specified in an application configuration file. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/Attachment/Overview/mail.cs" id="Snippet7"::: - - ]]> - + To be added. The value specified for a set operation is . The value specified for a set operation is equal to (""). You cannot change the value of this property when an email is being sent. - mailSettings for system.net - <smtp> Element (Network Settings) - <network> Element (Network Settings) @@ -930,8 +841,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> - <mailSettings> Element (Network Settings) - <smtp> Element (Network Settings) @@ -972,27 +881,10 @@ The following code example demonstrates sending an email message asynchronously. Gets or sets the port used for SMTP transactions. An that contains the port number on the SMTP host. The default value is 25. - - property can also be set using constructors or the application or machine configuration file. For more information about using configuration files, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). If information is specified using this property, this information overrides the configuration file settings. - - - -## Examples - The following code example demonstrates sending an email message by using the host and port specified in an application configuration file. - - :::code language="csharp" source="~/snippets/csharp/System.Net.Mail/Attachment/Overview/mail.cs" id="Snippet7"::: - - ]]> - + To be added. The value specified for a set operation is less than or equal to zero. You cannot change the value of this property when an email is being sent. - mailSettings for system.net - <smtp> Element (Network Settings) - <network> Element (Network Settings) @@ -2138,7 +2030,6 @@ The following code example demonstrates sending an email message asynchronously. -or- is zero. - connectionManagement Element (Network Settings) Managing Connections @@ -2192,9 +2083,6 @@ The following code example demonstrates sending an email message asynchronously. ]]> Integrated Windows Authentication with Extended Protection - <mailSettings> Element (Network Settings) - <smtp> Element (Network Settings) - <network> Element (Network Settings) @@ -2292,7 +2180,7 @@ The following code example demonstrates sending an email message asynchronously. System.Boolean - Gets or sets a value that controls whether the are sent with requests. + Gets or sets a value that indicates whether the are sent with requests. if the default credentials are used; otherwise . The default value is . @@ -2301,14 +2189,10 @@ The following code example demonstrates sending an email message asynchronously. ## Remarks Some SMTP servers require that the client be authenticated before the server sends email on its behalf. Set this property to `true` when this object should, if requested by the server, authenticate using the default credentials of the currently logged on user. For client applications, this is the desired behavior in most scenarios. - Credentials information can also be specified using the application and machine configuration files. For more information, see [<mailSettings> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/mailsettings-element-network-settings). - If the property is set to `false,` then the value set in the property will be used for the credentials when connecting to the server. If the property is set to `false` and the property has not been set, then mail is sent to the server anonymously. > [!CAUTION] -> If you provide credentials for basic authentication, they are sent to the server in clear text. This can present a security issue because your credentials can be seen, and then used by others. - - +> If you provide credentials for basic authentication, they are sent to the server in clear text. This can present a security issue because your credentials can be seen and used by others. ## Examples The following code example demonstrates using this property. diff --git a/xml/System.Net.Mail/SmtpPermission.xml b/xml/System.Net.Mail/SmtpPermission.xml index 5c1ad293276..fbe36f304f9 100644 --- a/xml/System.Net.Mail/SmtpPermission.xml +++ b/xml/System.Net.Mail/SmtpPermission.xml @@ -49,10 +49,6 @@ [!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)] - The and classes control access to SMTP host computers. The class demands an when sending electronic mail to the SMTP host for delivery. - - The enumeration specifies the level of access controlled by an instance of this permission. - ]]> @@ -98,14 +94,7 @@ if the new permission is unrestricted; otherwise, . Initializes a new instance of the class with the specified state. - - access to SMTP servers. If unrestricted is `false`, the permission controls access. - - ]]> - + To be added. @@ -139,14 +128,7 @@ One of the values. Initializes a new instance of the class using the specified access level. - - - + To be added. @@ -180,14 +162,7 @@ One of the values. Initializes a new instance of the class using the specified permission state value. - - - + To be added. @@ -258,14 +233,7 @@ One of the values. Adds the specified access level value to the permission. - - - + To be added. @@ -300,14 +268,7 @@ Creates and returns an identical copy of the current permission. An that is identical to the current permission. - - - + To be added. @@ -344,14 +305,7 @@ The XML encoding to use to set the state of the current permission. Sets the state of the permission using the specified XML encoding. - - - + To be added. does not describe an object. @@ -397,14 +351,7 @@ An to intersect with the current permission. It must be of the same type as the current permission. Creates and returns a permission that is the intersection of the current permission and the specified permission. An that represents the intersection of the current permission and the specified permission. Returns if the intersection is empty or is . - - - + To be added. is not an . @@ -445,14 +392,7 @@ Returns a value indicating whether the current permission is a subset of the specified permission. if the current permission is a subset of the specified permission; otherwise, . - - - + To be added. is not an . @@ -493,14 +433,7 @@ Returns a value indicating whether the current permission is unrestricted. if the current permission is unrestricted; otherwise, . - - - + To be added. @@ -535,14 +468,7 @@ Creates an XML encoding of the state of the permission. A that contains an XML encoding of the current permission. - - - + To be added. @@ -580,14 +506,7 @@ An to combine with the current permission. Creates a permission that is the union of the current permission and the specified permission. A new permission that represents the union of the current permission and the specified permission. - - method returns a permission that represents all the states represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. - - ]]> - + To be added. is not an . diff --git a/xml/System.Net.Mail/SmtpPermissionAttribute.xml b/xml/System.Net.Mail/SmtpPermissionAttribute.xml index b157c7c20c8..8eb0109d39f 100644 --- a/xml/System.Net.Mail/SmtpPermissionAttribute.xml +++ b/xml/System.Net.Mail/SmtpPermissionAttribute.xml @@ -49,10 +49,6 @@ [!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)] - The and classes control access to SMTP host computers. The class demands an when sending electronic mail to the SMTP host for delivery. - - The enumeration specifies the level of access controlled by an instance of this permission. - ]]> @@ -88,14 +84,7 @@ One of the values that specifies the permission behavior. Initializes a new instance of the class. - - - + To be added. is not a valid . @@ -131,14 +120,7 @@ Gets or sets the level of access to SMTP servers controlled by the attribute. A value. Valid values are "Connect" and "None". - - method will throw an when called by the system. - - ]]> - + To be added. @@ -173,16 +155,7 @@ Creates a permission object that can be stored with the in an assembly's metadata. An instance. - - - + To be added. diff --git a/xml/System.Net.NetworkInformation/NetworkChange.xml b/xml/System.Net.NetworkInformation/NetworkChange.xml index 43297d0dc72..dfd931921f5 100644 --- a/xml/System.Net.NetworkInformation/NetworkChange.xml +++ b/xml/System.Net.NetworkInformation/NetworkChange.xml @@ -67,7 +67,7 @@ ## Examples The following code example listens for address changes and displays the status of network interfaces when a event occurs. - + :::code language="csharp" source="~/snippets/csharp/System.Net.NetworkInformation/NetworkChange/Overview/changed.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Net.NetworkInformation/NetworkChange/Overview/changed.vb" id="Snippet1"::: diff --git a/xml/System.Net.NetworkInformation/NetworkInformationPermission.xml b/xml/System.Net.NetworkInformation/NetworkInformationPermission.xml index 29603e8d3f6..31dcba35f9d 100644 --- a/xml/System.Net.NetworkInformation/NetworkInformationPermission.xml +++ b/xml/System.Net.NetworkInformation/NetworkInformationPermission.xml @@ -50,10 +50,6 @@ [!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)] - This permission is used to secure data returned by the classes in the namespace. - - For declarative security, use the class. - ]]> @@ -100,14 +96,7 @@ One of the values. Initializes a new instance of the class using the specified value. - - - + To be added. @@ -142,14 +131,7 @@ One of the values. Initializes a new instance of the class with the specified . - - - + To be added. @@ -184,14 +166,7 @@ Gets the level of access to network information controlled by this permission. One of the values. - - created with is given | access. A created with is given access. - - ]]> - + To be added. @@ -229,14 +204,7 @@ One of the values. Adds the specified value to this permission. - - - + To be added. @@ -272,14 +240,7 @@ Creates and returns an identical copy of this permission. A that is identical to the current permission. - - - + To be added. @@ -317,14 +278,7 @@ A that contains the XML encoding to use to set the state of the current permission. Sets the state of this permission using the specified XML encoding. - - - + To be added. is . @@ -375,14 +329,7 @@ An to intersect with the current permission. It must be of the same type as the current permission. Creates and returns a permission that is the intersection of the current permission and the specified permission. A that represents the intersection of the current permission and the specified permission. This new permission is if the intersection is empty or is . - - - + To be added. is not a . @@ -424,14 +371,7 @@ Determines whether the current permission is a subset of the specified permission. if the current permission is a subset of the specified permission; otherwise, . - - - + To be added. @@ -471,14 +411,7 @@ Returns a value indicating whether the current permission is unrestricted. if the current permission is unrestricted; otherwise, . - - constructor. - - ]]> - + To be added. @@ -514,14 +447,7 @@ Creates an XML encoding of the state of this permission. A that contains the XML encoding of the current permission. - - - + To be added. @@ -560,14 +486,7 @@ A permission to combine with the current permission. Creates a permission that is the union of this permission and the specified permission. A new permission that represents the union of the current permission and the specified permission. - - method returns a permission that represents all the states represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. - - ]]> - + To be added. diff --git a/xml/System.Net.NetworkInformation/NetworkInformationPermissionAttribute.xml b/xml/System.Net.NetworkInformation/NetworkInformationPermissionAttribute.xml index 5e95200a1c0..dcd63d70e0b 100644 --- a/xml/System.Net.NetworkInformation/NetworkInformationPermissionAttribute.xml +++ b/xml/System.Net.NetworkInformation/NetworkInformationPermissionAttribute.xml @@ -44,16 +44,12 @@ Allows security actions for to be applied to code using declarative security. - namespace. - - The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the class. - ]]> @@ -90,14 +86,7 @@ A value that specifies the permission behavior. Initializes a new instance of the class. - - - + To be added. @@ -132,20 +121,7 @@ Gets or sets the network information access level. A string that specifies the access level. - - - + To be added. @@ -181,14 +157,7 @@ Creates and returns a new object. A that corresponds to this attribute. - - - + To be added. diff --git a/xml/System.Net.NetworkInformation/PhysicalAddress.xml b/xml/System.Net.NetworkInformation/PhysicalAddress.xml index a4b74b5eaf9..151e0a86851 100644 --- a/xml/System.Net.NetworkInformation/PhysicalAddress.xml +++ b/xml/System.Net.NetworkInformation/PhysicalAddress.xml @@ -467,27 +467,17 @@ method to retrieve the address from an existing instance. - - ## Examples The following code example creates a instance by calling the method. diff --git a/xml/System.Net.NetworkInformation/Ping.xml b/xml/System.Net.NetworkInformation/Ping.xml index b59a82cfc80..95d69921909 100644 --- a/xml/System.Net.NetworkInformation/Ping.xml +++ b/xml/System.Net.NetworkInformation/Ping.xml @@ -114,10 +114,6 @@ ]]> - How to: Ping a Host - Network Programming in the .NET Framework - Network Programming Samples - NetworkInformation diff --git a/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermission.xml b/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermission.xml index d9360bdd72f..a2a4a22b748 100644 --- a/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermission.xml +++ b/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermission.xml @@ -49,10 +49,6 @@ [!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)] - The default allow all local and Intranet zone applications to access collaboration services, and no permission is granted for Internet zone applications. In other words, if the default permissions are not changed, all link-local and site-local applications have access to Peer-To-Peer collaboration services, but global applications have no access. - - This class is not derivable. - ]]> @@ -91,16 +87,7 @@ One of the values in the enumeration. Initializes a new instance of the . The initial for this instance is passed when the constructor is called. - - , the instance passes all demands. If state contains any other value, the instance fails all demands. - - ]]> - + To be added. @@ -137,14 +124,7 @@ Creates and returns a copy of the current . A that contains a copy of the current instance of . - - instance grants the same access to resources as the original permission. - - ]]> - + To be added. @@ -182,16 +162,7 @@ The XML encoding to use to reconstruct the permission. Represents the XML object model for encoding security objects. - - - + To be added. The parameter is not a valid permission element. -or- @@ -241,22 +212,7 @@ The parameter's version number is not supported. Permission to with the current permission. It must be of the same type as the current permission. Creates and returns a permission that is the intersection of the current and the specified permission. A new permission that represents the intersection of the current and the specified permission. This new permission is a reference ( in Visual Basic) if the intersection is empty. - - method. X and Y represent object references that are not a `null` reference (`Nothing` in Visual Basic). - -- X.Intersect(X) returns a value equal to X. - -- X.Intersect(Y) returns the same value as Y.Intersect(X). - -- X.Intersect(a `null` reference) returns a `null` reference. - - ]]> - + To be added. The target parameter is not a reference ( in Visual Basic) and is not an instance of the same class as the current permission. @@ -299,24 +255,7 @@ The parameter's version number is not supported. Determines whether the current is a subset of the specified permission. if the current is a subset of the specified permission; otherwise, . - - is a subset of the specified permission if the current permission specifies a set of operations that is wholly contained by the specified permission. For example, a permission that represents access to "*C:\example.txt*" is a subset of a permission that represents access to "*C:\\*". If this method returns `true`, the current permission represents no more access to the protected resource than does the specified permission. - - The following statements are required to be `true` for all implementations of the method. X, Y, and Z represent objects that are not a `null` reference (`Nothing` in Visual Basic). - -- X.IsSubsetOf(X) returns `true`. - -- X.IsSubsetOf(Y) returns the same value as Y.IsSubsetOf(X) if and only if X and Y represent the same set of permissions. - -- If X.IsSubsetOf(Y) and Y.IsSubsetOf(Z) both return `true`, X.IsSubsetOf(Z) returns `true`. - - If X represents an empty object with a permission state of `None`, and Y represents an `IPermission` object that is a `null` reference (`Nothing` in Visual Basic), X.IsSubsetOf(Y) returns `true`. If Z is also an empty permission, the compound set operation X.Union(Z).IsSubsetOf(Y) also returns `true` because the of two empty permissions is an empty permission. - - ]]> - + To be added. The parameter is a reference ( in Visual Basic). @@ -359,14 +298,7 @@ The parameter's version number is not supported. Returns a value specifying whether the current is unrestricted. if the current permission is unrestricted; otherwise, . - - - + To be added. @@ -404,14 +336,7 @@ The parameter's version number is not supported. Creates an XML encoding of the and its current state. An XML encoding of the permission, including any state information. - - - + To be added. @@ -451,22 +376,7 @@ The parameter's version number is not supported. A permission to combine with the current permission. It must be of the same type as the current permission. Creates a permission that is the union of the current and the specified permission. A new permission that represents the of the current and the specified permission. - - is a permission that represents all the operations represented by both the current and the specified permission. Any demand that passes either permission passes their union. - - The following statements are required to be `true` for all implementations of the Union method. X and Y represent objects that are not a `null` reference (`Nothing` in Visual Basic). - -- X.Union(X) returns an object that has the same value as X. - -- X.Union(Y) returns an object that has the same value as the object returned by Y.Union(X). - -- X.Union(a `null` reference (`Nothing` in Visual Basic)) returns an object that has the same value as X. - - ]]> - + To be added. The parameter is a reference ( in Visual Basic). diff --git a/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermissionAttribute.xml b/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermissionAttribute.xml index 80843c310fe..906b1141c46 100644 --- a/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermissionAttribute.xml +++ b/xml/System.Net.PeerToPeer.Collaboration/PeerCollaborationPermissionAttribute.xml @@ -43,16 +43,12 @@ Allows security actions for to be applied to code using declarative security. This class cannot be inherited. - that is used. - - The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class. - ]]> @@ -90,14 +86,7 @@ Specifies a value. Initializes a new instance of the class with the specified . - - works with to allow or deny a peer access to the collaboration session. - - ]]> - + To be added. @@ -133,14 +122,7 @@ Creates and returns a new . A new object. - - . - - ]]> - + To be added. When permissions are inherited , must be overridden. diff --git a/xml/System.Net.PeerToPeer/PnrpPermission.xml b/xml/System.Net.PeerToPeer/PnrpPermission.xml index 1eff1490e65..542ad4d6fee 100644 --- a/xml/System.Net.PeerToPeer/PnrpPermission.xml +++ b/xml/System.Net.PeerToPeer/PnrpPermission.xml @@ -49,17 +49,8 @@ [!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)] - The default permissions allow all local and Intranet zone applications to access PNRP services. If the default permissions are not changed, all link-local and site-local applications have access to Peer-to-Peer services, but global (internet) applications have no access. - - Instances of this type have two permission states: they either have no access to the resources protected by the permission, or they have unrestricted full access to those resources. - ]]> - - - - - PNRP Namespace Provider API @@ -93,20 +84,7 @@ One of the values in the enumeration. Initializes a new instance of the class with the supplied initial permission state. - - - - - - - + To be added. @@ -141,26 +119,13 @@ Creates and returns an identical copy of the current . An object with an IPermission interface, whose instance contains a copy of the current instance of . - - - + To be added. The parameter is not a valid element. -or- The parameter's version number is not supported. The parameter is a reference ( in Visual Basic). - - - - PNRP Namespace Provider API @@ -197,25 +162,13 @@ The parameter's version number is not supported. The XML encoding to use to reconstruct the permission. Reconstructs a security object with a specified state from an XML encoding. - - - + To be added. The parameter is not a valid element. -or- The parameter's version number is not supported. The parameter is a reference ( in Visual Basic). - - - @@ -253,26 +206,8 @@ The parameter's version number is not supported. A permission to with the current permission. It must be of the same type as the current permission. Creates and returns a permission that is the intersection of the current and the specified permission. A new permission that represents the intersection of the current and the specified permission. This new permission is a reference ( in Visual Basic) if the intersection is empty. - - object references that are not a `null` reference (Nothing in Visual Basic). - -- X.Intersect(X) returns a value equal to X. - -- X.Intersect(Y) returns the same value as Y.Intersect(X). - -- X.Intersect(a `null` reference (`Nothing` in Visual Basic)) returns a `null` reference (`Nothing` in Visual Basic). - - ]]> - + To be added. The target parameter is not a reference ( in Visual Basic) and is not an instance of the same class as the current permission. - - - @@ -311,29 +246,8 @@ The parameter's version number is not supported. Determines whether the current is a subset of the specified permission. if the current is a subset of the specified permission; otherwise, . - - is a subset of the specified permission if the current permission specifies a set of operations that is wholly contained by the specified permission. For example, a permission that represents access to "*C:\example.txt*" is a subset of a permission that represents access to "*C:\\*". If this method returns `true`, the current permission represents no more access to the protected resource than does the specified permission. - -The following statements are required to be `true` for all implementations of the IsSubsetOf method. X, Y, and Z represent objects that are not a `null` reference (`Nothing` in Visual Basic). - -- `X.IsSubsetOf(X)` returns `true`. - -- `X.IsSubsetOf(Y)` returns the same value as `Y.IsSubsetOf(X)` if and only if X and Y represent the same set of permissions. - -- If `X.IsSubsetOf(Y)` and `Y.IsSubsetOf(Z)` both return `true`, `X.IsSubsetOf(Z)` returns `true`. - -If X represents an empty object with a permission state of *None*, and Y represents an object that is a `null` reference (`Nothing` in Visual Basic), `X.IsSubsetOf(Y)` returns `true`. If Z is also an empty permission, the compound set operation `X.Union(Z).IsSubsetOf(Y)` also returns `true` because the of two empty permissions is an empty permission. - - ]]> - + To be added. The target parameter is not a reference ( in Visual Basic) and is not an instance of the same class as the current permission. - - - @@ -372,18 +286,7 @@ If X represents an empty object with a permis Returns a value specifying whether the current is unrestricted. if the current permission is unrestricted; otherwise, . - - - - - - - + To be added. @@ -419,8 +322,6 @@ If X represents an empty object with a permis Creates an XML encoding of the and its current state. A object that contains an XML encoding of the permission, including any state information. To be added. - - @@ -458,27 +359,9 @@ If X represents an empty object with a permis A permission to combine with the current permission. It must be of the same type as the current permission. Creates a permission that is the union of the current and the specified permission. A new permission that represents the of the current and the specified permission. - - is a permission that represents all the operations represented by both the current and the specified permission. Any demand that passes either permission passes their union. - - The following statements are required to be `true` for all implementations of the Union method. X and Y represent objects that are not a `null` reference (`Nothing` in Visual Basic). - -- X.Union(X) returns an object that has the same value as X. - -- X.Union(Y) returns an object that has the same value as the object returned by Y.Union(X). - -- X.Union(a `null` reference (`Nothing` in Visual Basic)) returns an object that has the same value as X. - - ]]> - + To be added. parameter is invalid. - - - diff --git a/xml/System.Net.PeerToPeer/PnrpPermissionAttribute.xml b/xml/System.Net.PeerToPeer/PnrpPermissionAttribute.xml index 126caeac640..6cdcd0a4a32 100644 --- a/xml/System.Net.PeerToPeer/PnrpPermissionAttribute.xml +++ b/xml/System.Net.PeerToPeer/PnrpPermissionAttribute.xml @@ -43,16 +43,12 @@ Allows security actions for to be applied to code using declarative security. - that is used. - - The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class. - ]]> @@ -88,14 +84,7 @@ One of the values. Initializes a new instance of the class with the specified . - - works with to allow or deny actions by the peer granted the permission and the permission attribute. - - ]]> - + To be added. @@ -133,11 +122,6 @@ Creates and returns a new . A new object. To be added. - - This method is not used, and is included only to support inheritance from at compile time or during interpretation. - - When this class inherits from , it overrides automatically at compile time or at run-time. - diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index f9fd8b5198e..1bf455ee238 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -46,7 +46,7 @@ and, in .NET 5 and later versions, for . + This property bag is used as argument for and . The uses this property bag in the property. diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 0680cb37634..922c3c34e10 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -87,15 +87,9 @@ assumes that a timeout along with any other when one is thrown from the inner stream will be treated as fatal by its caller. Reusing a instance after a timeout will return garbage. An application should the and throw an exception in these cases. - The .NET Framework 4.6 includes a security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as HttpClient, HttpWebRequest, FTPClient, SmtpClient, and SslStream and targeting .NET Framework 4.6 get the more-secure behavior by default. - - Developers may want to opt out of this behavior in order to maintain interoperability with their existing SSL3 services OR TLS w/ RC4 services. [This article](https://support.microsoft.com/kb/3069494) explains how to modify your code so that the new behavior is disabled. - - The .NET Framework 4.7 adds new overloads for the methods that authenticate SslStreams that do not specify a TLS version, but instead use the TLS version defined as the system default in [SCHANNEL](/windows/win32/secauthn/secure-channel). Use these methods in your app as a way to be able to later modify the defaults as TLS version best practice changes over time, without the need to rebuild and redeploy your app. - - Also see [Transport Layer Security (TLS) best practices with the .NET Framework](/dotnet/framework/network-programming/tls). - +To opt out of the behavior that blocks insecure cipher and hashing algorithms for connections in order to maintain interoperability with your existing SSL3 services OR TLS w/ RC4 services, see [Cannot connect to a server by using the ServicePointManager or SslStream APIs after upgrade to the .NET Framework 4.6](https://support.microsoft.com/kb/3069494). +Use the the overloads for methods that authenticate SslStreams that don't specify a TLS version, but instead use the TLS version defined as the system default in [SCHANNEL](/windows/win32/secauthn/secure-channel), as a way to be able to later modify the defaults, without the need to rebuild and redeploy your app. ## Examples The following code example demonstrates creating an that uses the class to communicate with clients. @@ -337,12 +331,10 @@ The use of the Null cipher is required when the encryption policy is set to . > [!NOTE] -> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, the Framework uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. +> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. > [!NOTE] -> Client certificates are not supported in the SSL version 2 protocol. - - +> Client certificates are not supported in the SSL version 2 protocol. ## Examples The following code example creates an and initiates the client portion of the authentication. @@ -436,8 +428,7 @@ The use of the Null cipher is required when the encryption policy is set to . > [!NOTE] -> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, the Framework uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. - +> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. ## Examples The following code example demonstrates calling this constructor. This example is part of a larger example provided for the class. diff --git a/xml/System.Net.Sockets/IPProtectionLevel.xml b/xml/System.Net.Sockets/IPProtectionLevel.xml index 8ba53f31c65..54cd8866ffe 100644 --- a/xml/System.Net.Sockets/IPProtectionLevel.xml +++ b/xml/System.Net.Sockets/IPProtectionLevel.xml @@ -44,18 +44,17 @@ A value that enables restriction of an IPv6 socket to a specified scope, such as addresses with the same link local or site local prefix. - - <socket> Element (Network Settings) diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index 782cc0b2263..480824bada9 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -82,14 +82,6 @@ implementation, this may lead to unintended data interleaving for large or multi - Network Programming in the .NET Framework - Best Practices for System.Net Classes - Cache Management for Network Applications - Internet Protocol Version 6 - Network Programming Samples - Network Tracing in the .NET Framework - Security in Network Programming - Socket Performance Enhancements in Version 3.5 @@ -250,9 +242,6 @@ This method populates the instance with data ga > [!NOTE] > If this constructor throws a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> The combination of and results in an invalid socket. @@ -311,11 +300,6 @@ This method populates the instance with data ga > [!NOTE] > If this constructor throws a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how to create an instance of the class. @@ -385,11 +369,6 @@ This method populates the instance with data ga > [!NOTE] > Before calling the method, you must first call the method to listen for and queue incoming connection requests. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example accepts a simple connection. @@ -776,11 +755,6 @@ This method populates the instance with data ga If the remote host shuts down or closes the connection, can throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example compares the results of calling IOControl with FIONREAD and the Available property. @@ -878,9 +852,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -892,14 +863,11 @@ This method populates the instance with data ga -or- The accepted socket is bound. - .NET Framework only: An error occurred when attempting to access the socket. - Asynchronous Client Socket Example - Asynchronous Server Socket Example @@ -976,9 +944,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -992,14 +957,11 @@ This method populates the instance with data ga The accepted socket is bound. is less than 0. - .NET Framework only: An error occurred when attempting to access the socket. - Asynchronous Client Socket Example - Asynchronous Server Socket Example @@ -1078,9 +1040,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1094,14 +1053,11 @@ This method populates the instance with data ga The accepted socket is bound. is less than 0. - .NET Framework only: An error occurred when attempting to access the socket. - Asynchronous Client Socket Example - Asynchronous Server Socket Example @@ -1197,9 +1153,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1207,7 +1160,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. The has been placed in a listening state by calling , or an asynchronous operation is already in progress. @@ -1308,9 +1260,6 @@ This method populates the instance with data ga > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1318,7 +1267,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. The has been closed. The is not in the socket family. The port number is not valid. @@ -1421,9 +1369,6 @@ This method populates the instance with data ga > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1431,7 +1376,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. The has been closed. This method is valid for sockets that use or . The port number is not valid. @@ -1534,9 +1478,6 @@ This method populates the instance with data ga > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1627,13 +1568,9 @@ This method populates the instance with data ga > [!NOTE] > If you receive a exception, use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> The object has been closed. - .NET Framework only: An error occurred when attempting to access the socket. @@ -1730,9 +1667,6 @@ This method populates the instance with data ga > [!NOTE] > `state` is an instantiation of a user-defined class. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1740,7 +1674,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. has been closed. @@ -1832,9 +1765,6 @@ This method populates the instance with data ga > [!NOTE] > `state` is an instantiation of a user-defined class. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1842,7 +1772,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. has been closed. @@ -1944,9 +1873,6 @@ This method populates the instance with data ga > [!NOTE] > `state` is an instantiation of a user-defined class. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -1954,7 +1880,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. has been closed. @@ -2064,9 +1989,6 @@ This method populates the instance with data ga > [!NOTE] > `state` is an instantiation of a user-defined class. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2074,7 +1996,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. has been closed. @@ -2196,9 +2117,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2210,7 +2128,6 @@ This method populates the instance with data ga -or- is . - .NET Framework only: An error occurred when attempting to access the socket. is less than 0. @@ -2322,9 +2239,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2336,7 +2250,6 @@ This method populates the instance with data ga -or- is . - .NET Framework only: An error occurred when attempting to access the socket. is less than 0. @@ -2453,9 +2366,6 @@ This method populates the instance with data ga > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2465,7 +2375,6 @@ This method populates the instance with data ga is . is empty. - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. The has been closed. @@ -2560,9 +2469,6 @@ This method populates the instance with data ga > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2572,7 +2478,6 @@ This method populates the instance with data ga is . is empty. - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. The has been closed. @@ -2677,9 +2582,6 @@ This method populates the instance with data ga > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2687,7 +2589,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. is less than 0. @@ -2800,9 +2701,6 @@ This method populates the instance with data ga > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2810,7 +2708,6 @@ This method populates the instance with data ga is . - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. is less than 0. @@ -2916,9 +2813,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a exception, use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -2927,7 +2821,6 @@ This method populates the instance with data ga The object has been closed. The socket is not connected to a remote host. The file was not found. - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. @@ -3009,16 +2902,12 @@ This method populates the instance with data ga > [!NOTE] > If you receive a exception, use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> The object has been closed. - .NET Framework only: An error occurred when attempting to access the socket. See remarks section below. The operating system is not Windows NT or later. -or- @@ -3119,9 +3008,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. @@ -3133,7 +3019,6 @@ This method populates the instance with data ga -or- is . - .NET Framework only: An error occurred when attempting to access the socket. is less than 0. @@ -3223,9 +3108,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -3300,9 +3182,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> An error occurred when attempting to access the socket. @@ -3426,9 +3305,6 @@ This method populates the instance with data ga > [!NOTE] > To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time out period. Use this along with the socket option to call the method. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -3497,9 +3373,6 @@ This method populates the instance with data ga > [!NOTE] > To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time-out period. Use this along with the socket option to call the method. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -3583,9 +3456,6 @@ This method populates the instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -3672,9 +3542,6 @@ This method populates the instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3752,9 +3619,6 @@ This method populates the instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3834,9 +3698,6 @@ This method populates the instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -4583,9 +4444,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -4816,9 +4674,6 @@ This method populates the instance with data ga When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -4989,8 +4844,6 @@ The target process should use the constructor multiple times using the same byte array in the argument in each call. If you do, you'll have multiple managed instances with the same underlying socket, which is strongly discouraged. -On .NET Framework, if the process creating the socket uses asynchronous methods, the process must first set the property to `true`. Otherwise, the asynchronous method will bind the socket to an [I/O completion port](/windows/win32/fileio/i-o-completion-ports) of the creating process, which may cause an to be thrown in the target process. - has limited support on Windows. Unlike on .NET Framework, the property is a NOP, therefore the process creating the socket must never call asynchronous methods on the socket. A call to an asynchronous operation will always bind it to an [I/O completion port](/windows/win32/fileio/i-o-completion-ports) of the creating process, which may cause an to be thrown in the target process. ]]> @@ -5132,9 +4985,6 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5146,7 +4996,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. method was previously called. @@ -5214,12 +5063,8 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. is empty. @@ -5293,12 +5138,8 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. is empty. @@ -5366,9 +5207,6 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5382,7 +5220,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5441,12 +5278,8 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. is . @@ -5531,9 +5364,6 @@ Duplication of the socket reference failed. > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5547,7 +5377,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5616,9 +5445,6 @@ Duplication of the socket reference failed. > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5632,7 +5458,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5699,9 +5524,6 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5715,7 +5537,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5797,7 +5618,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5875,9 +5695,6 @@ Duplication of the socket reference failed. > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5891,7 +5708,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -5965,9 +5781,6 @@ Duplication of the socket reference failed. > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -5981,7 +5794,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -6044,13 +5856,9 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> .NET 8+ only: The socket is not connected to a remote host. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. is empty. @@ -6121,9 +5929,6 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -6137,7 +5942,6 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - .NET Framework, .NET Core, and .NET 5-6 only: The has been closed. @@ -6369,9 +6173,6 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -6448,9 +6249,6 @@ In general, the `GetSocketOption` method should be used whenever getting a option, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. Use this overload for any sockets that are represented by Boolean values or integers. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -6529,9 +6327,6 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -6663,9 +6458,6 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -6738,9 +6530,6 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -6987,9 +6776,6 @@ The maximum length of the pending connections queue is determined automatically. > [!NOTE] > You must call the method before calling , or will throw a . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > The backlog parameter is limited to different values depending on the Operating System. You may specify a higher value, but the backlog will be limited based on the Operating System. @@ -7068,9 +6854,6 @@ The maximum length of the pending connections queue is determined automatically. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -7402,9 +7185,6 @@ The maximum length of the pending connections queue is determined automatically. > [!NOTE] > This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example creates a socket, connects to a server, and uses to check the status of the socket. @@ -7590,9 +7370,6 @@ The maximum length of the pending connections queue is determined automatically. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -7684,8 +7461,6 @@ The maximum length of the pending connections queue is determined automatically. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - **Note** This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -7747,8 +7522,6 @@ If you're using a connectionless , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). ]]> An error occurred when attempting to access the socket. @@ -7826,9 +7599,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -7922,9 +7692,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -8005,8 +7772,6 @@ If you're using a connectionless , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> An error occurred when attempting to access the socket. @@ -8086,9 +7851,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -8186,9 +7948,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -8264,9 +8023,6 @@ If you're using a connectionless , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> An error occurred when attempting to access the socket. @@ -8346,9 +8102,6 @@ If you're using a connectionless , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -8459,9 +8212,6 @@ If you're using a connectionless , , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -8965,9 +8715,6 @@ If you're using a connectionless , [!NOTE] > The of the used in needs to match the of the used in . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -9113,9 +8860,6 @@ If you're using a connectionless , [!NOTE] > The of the used in needs to match the of the used in . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -9309,9 +9053,6 @@ If you're using a connectionless , [!NOTE] > The of the used in needs to match the of the used in . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -9426,9 +9167,6 @@ If you're using a connectionless , [!NOTE] > The of the used in needs to match the of the used in . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -9932,9 +9670,6 @@ You must call the Bind method before performing this operation. > [!NOTE] > The of the used in needs to match the of the used in . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -9966,7 +9701,7 @@ You must call the Bind method before performing this operation. -or- - The .NET Framework is running on an AMD 64-bit processor. + .NET is running on an AMD 64-bit processor. -or- @@ -10373,9 +10108,6 @@ You must call the Bind method before performing this operation. The is set after a call to either or . If you try to access this property earlier, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -10641,9 +10373,6 @@ You must call the Bind method before performing this operation. > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -10734,9 +10463,6 @@ You must call the Bind method before performing this operation. > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -10800,8 +10526,6 @@ If you're using a connection-oriented protocol, [!NOTE] >If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!IMPORTANT] >The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. @@ -10881,9 +10605,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -10974,9 +10695,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -11104,8 +10822,6 @@ With a connection-oriented protocol, will > [!NOTE] > You must ensure that the size does not exceed the maximum packet size of the underlying service provider. If it does, the datagram won't be sent and will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!IMPORTANT] >The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. @@ -11207,9 +10923,6 @@ The following code example sends the data found in buffer, and specifies [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -11276,8 +10989,6 @@ If you're using a connection-oriented protocol, [!NOTE] >If you receive a , use the property to obtain the specific error code. After you've obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!IMPORTANT] >The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. @@ -11363,9 +11074,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -11478,9 +11186,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples @@ -11982,9 +11687,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example creates and connects a socket and then sends a file to the remote host. The file "test.txt" is located in the root directory of the local machine. @@ -12066,9 +11768,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example creates and connects a socket. The file "test.txt" is located in the root directory of the local machine. In this example, we create a prebuffer and postbuffer of data and send them to the remote host with the file. The default are used. @@ -12448,9 +12147,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sends a connectionless datagram to the specified remote host. @@ -12586,9 +12282,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sends a connectionless datagram to the specified remote host. are passed to the method. @@ -12774,9 +12467,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sends a connectionless datagram to the specified remote host. The size and are passed to the method. @@ -12871,9 +12561,6 @@ This member outputs trace information when you enable network tracing in your ap > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sends a connectionless datagram to the specified remote host. The offset, size, and are passed to the method. @@ -13543,9 +13230,6 @@ The [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sets the and time-out values. @@ -13683,9 +13367,6 @@ The [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example sets the and time-out values. @@ -13848,9 +13529,6 @@ The [!NOTE] > If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ## Examples The following code example uses to disable the . @@ -14038,17 +13716,10 @@ The System.Boolean - Gets a value that indicates whether the Framework supports IPv6 for certain obsolete members. + Gets a value that indicates whether the framework supports IPv6 for certain obsolete members. - if the Framework supports IPv6 for certain obsolete methods; otherwise, . - - - + if the framework supports IPv6 for certain obsolete methods; otherwise, . + To be added. @@ -14163,20 +13834,9 @@ The System.Boolean - Gets or sets a value that specifies whether the socket should only use Overlapped I/O mode. On .NET 5+ (including .NET Core versions), the value is always . - - on .NET Framework if the uses only overlapped I/O; otherwise, . The default is . - - you intend to call on. Otherwise, the Framework may assign a completion port to the socket, which would prohibit the use of . - -On .NET 5+ (include .NET Core) versions, the value of this property is always `false`, and you cannot change its value. - - ]]> - + Gets or sets a value that specifies whether the socket should only use Overlapped I/O mode. + Always . + The value of this property is always `false`, and you cannot change its value. The socket has been bound to a completion port. diff --git a/xml/System.Net.Sockets/SocketAsyncEventArgs.xml b/xml/System.Net.Sockets/SocketAsyncEventArgs.xml index f8a0dac1e8a..d9c7332400d 100644 --- a/xml/System.Net.Sockets/SocketAsyncEventArgs.xml +++ b/xml/System.Net.Sockets/SocketAsyncEventArgs.xml @@ -100,9 +100,6 @@ - Network Programming in the .NET Framework - Network Tracing in the .NET Framework - Socket Performance Enhancements in Version 3.5 @@ -762,9 +759,6 @@ When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> diff --git a/xml/System.Net.Sockets/SocketFlags.xml b/xml/System.Net.Sockets/SocketFlags.xml index ef768b2fd1f..2e33d853501 100644 --- a/xml/System.Net.Sockets/SocketFlags.xml +++ b/xml/System.Net.Sockets/SocketFlags.xml @@ -56,7 +56,7 @@ ## Examples The following example sends data and specifies `SocketFlags.None`. - + :::code language="csharp" source="~/snippets/csharp/System.Net.Sockets/Socket/Receive/source.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Net.Sockets/Socket/Receive/source.vb" id="Snippet3"::: diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index 53dc7ea94b0..33cae15c70a 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -147,14 +147,6 @@ ## Remarks This constructor creates a new and allows the underlying service provider to assign the most appropriate local IP address and port number. You must first call the method before sending and receiving data. -> [!NOTE] -> On .NET Framework, this constructor works only with IPv4 address types. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how to use the parameterless constructor to create a new . @@ -213,11 +205,6 @@ You must call the method before sending and receiving data. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how to create an instance of the class using a local endpoint. @@ -274,13 +261,6 @@ [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how to create an instance of the class. @@ -348,11 +328,6 @@ > [!NOTE] > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how to create an instance of the class using a host name and port number. @@ -852,11 +827,6 @@ The `Available` property is a way to determine whether data is queued for readin Calling this method will eventually result in the close of the associated `Socket` and will also close the associated that is used to send and receive data if one was created. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates closing a by calling the `Close` method. @@ -927,9 +897,6 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -999,12 +966,7 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified and port number. The method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1074,12 +1036,7 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call the `Connect` method to establish a synchronous remote host connection to the host specified by the array of elements and the port number. The `Connect` method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1154,11 +1111,6 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example uses the host name and port number to connect with a remote host. @@ -1227,9 +1179,6 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a , use to obtain the specific error code. After you've obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - > [!NOTE] > If you receive a `NotSupportedException` with the message "This protocol version is not supported" while using IPv6 address, make sure you enabled IPv6 in the constructor by passing . @@ -1292,12 +1241,7 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified and port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1365,12 +1309,7 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of elements and the port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1427,12 +1366,7 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified . Before you call `Connect`, you must create an instance of the `IPEndPoint` class using an IP address and a port number. Use this `IPEndPoint` as the `remoteEP` parameter. The `Connect` method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1497,12 +1431,7 @@ The `Available` property is a way to determine whether data is queued for readin If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1559,12 +1488,7 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified IP address and port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1624,12 +1548,7 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of IP addresses and the port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - -> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1692,12 +1611,7 @@ The `Available` property is a way to determine whether data is queued for readin If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1863,12 +1777,7 @@ The `Available` property is a way to determine whether data is queued for readin ## Remarks This method is called by the public `Dispose()` method and the method, if it has been overridden. `Dispose()` invokes this method with the `disposing` parameter set to `true`. `Finalize` invokes this method with `disposing` set to `false`. - When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. It does this by invoking the `Dispose()` method of each referenced object. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - ]]> + When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. It does this by invoking the `Dispose()` method of each referenced object. ]]> @@ -2104,11 +2013,6 @@ The `GetStream` method returns a that yo > [!NOTE] > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example uses `GetStream` to obtain the underlying . After obtaining the , it sends and receives using its and methods. diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 71769119f1e..4a2cf12f823 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -219,11 +219,6 @@ Call the method to begin listening for incoming connection attempts. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example creates an instance of the class using the local endpoint. @@ -288,11 +283,6 @@ Call the method to begin listening for incoming connection attempts. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example creates an instance of the class using a local IP address and port number. @@ -357,11 +347,6 @@ The returned is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples In the following code example, the method is used to return a . This is used to communicate with the newly connected client. @@ -421,12 +406,7 @@ ## Remarks This operation will not block. The returned object will complete after the socket connection has been accepted. - The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. - -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -480,9 +460,6 @@ The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -538,11 +515,6 @@ Use the method to obtain the underlying of the returned . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples In the following code example, the method is used to return a . This is used to communicate with the newly connected client. @@ -606,9 +578,6 @@ Use the method to obtain the underlying of the returned in the . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using or . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -665,9 +634,6 @@ Use the method to obtain the underlying of the returned in the . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using or . -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -864,9 +830,6 @@ > [!NOTE] > If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> An error occurred while attempting to access the socket. @@ -937,9 +900,6 @@ > [!NOTE] > If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> An error occurred while attempting to access the socket. @@ -1076,9 +1036,6 @@ > [!NOTE] > If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> The underlying has been closed. @@ -1144,9 +1101,6 @@ > [!NOTE] > If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> @@ -1463,11 +1417,6 @@ Use the method to close the and stop listening. You are responsible for closing your accepted connections separately. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how is used to listen for incoming client connection attempts. @@ -1538,11 +1487,6 @@ > [!NOTE] > Use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates how is used to listen for incoming client connection attempts. @@ -1607,11 +1551,6 @@ ## Remarks closes the listener. Any unaccepted connection requests in the queue will be lost. Remote hosts waiting for a connection to be accepted will throw a . You are responsible for closing your accepted connections separately. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - - - ## Examples The following code example demonstrates using the method to close the underlying . diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index f670b4f2c90..6e79676c220 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -940,8 +940,8 @@ Exactly one send and one receive is supported on each [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - [System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.")] - [<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.")>] + [System.Obsolete("This API supports the .NET infrastructure and is not intended to be used directly from your code.")] + [<System.Obsolete("This API supports the .NET infrastructure and is not intended to be used directly from your code.")>] From 7aa1374406e35859f574da26bdfd64a2f5191645 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 21 May 2026 20:25:06 -0700 Subject: [PATCH 2/5] fix typo --- xml/System.Net.Cache/HttpCacheAgeControl.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Cache/HttpCacheAgeControl.xml b/xml/System.Net.Cache/HttpCacheAgeControl.xml index 7a342cee19b..16ba48b1bb0 100644 --- a/xml/System.Net.Cache/HttpCacheAgeControl.xml +++ b/xml/System.Net.Cache/HttpCacheAgeControl.xml @@ -300,7 +300,7 @@ 0 - For internal use only.An is thrown if you try to use this member. + For internal use only. An is thrown if you try to use this member. From 8c9a665ca49b8face4d9baad4901f7d9466d8c13 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 22 May 2026 15:38:24 -0700 Subject: [PATCH 3/5] respond to feedback --- xml/System.Net.Http/HttpClient.xml | 87 ++-- xml/System.Net.Sockets/Socket.xml | 432 +++++++++++------- .../SocketAsyncEventArgs.xml | 3 + xml/System.Net.Sockets/TcpClient.xml | 112 ++++- xml/System.Net.Sockets/TcpListener.xml | 67 ++- 5 files changed, 477 insertions(+), 224 deletions(-) diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index 4e92e3056b1..a9a5f8735b8 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -589,7 +589,8 @@ This property has no effect on any of the object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The request message was already sent by the instance. @@ -658,7 +659,8 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The request message was already sent by the instance. @@ -733,7 +735,8 @@ The is not an absolute URI. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The request message was already sent by the instance. @@ -808,7 +811,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The request message was already sent by the instance. @@ -956,7 +960,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1018,7 +1023,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1085,7 +1091,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1153,7 +1160,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1221,7 +1229,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1284,7 +1293,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. The behavior is the same as if has been explicitly specified. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1357,7 +1367,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1427,7 +1438,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete based on the `completionOption` parameter after the part or all of the response (including content) is read. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1517,7 +1529,8 @@ The request failed due to timeout. In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of timeout, that nests a is thrown. +> In case of timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1812,7 +1825,8 @@ The request failed due to timeout. In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, that nests a is thrown. +> In case of a timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1880,7 +1894,8 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, that nests a is thrown. +> In case of a timeout, that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -1945,7 +1960,8 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout: an that nests a is thrown. +> In case of a timeout: an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The cancellation token was canceled. This exception is stored into the returned task. @@ -2011,7 +2027,8 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, an that nests a is thrown. +> In case of a timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is . @@ -2105,7 +2122,8 @@ The request failed due to timeout. In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, an that nests a is thrown. +> In case of a timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2173,7 +2191,8 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, an that nests a is thrown. +> In case of a timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2238,7 +2257,8 @@ The response status code was outside of the range of 200-299 (which indicate suc In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, an that nests a is thrown. +> In case of a timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is . @@ -2304,7 +2324,8 @@ The request failed due to timeout. In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return `200 OK`. In such cases, we recommend to manually check if matches the expected value. > [!NOTE] -> In case of a timeout, an that nests a is thrown. +> In case of a timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is . @@ -2699,7 +2720,8 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2763,7 +2785,8 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2835,7 +2858,8 @@ The size specified is greater than the maximum allowed buffer size. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2905,7 +2929,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -2998,7 +3023,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -3062,7 +3088,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -3134,7 +3161,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. @@ -3204,7 +3232,8 @@ The request failed due to timeout. This operation doesn't block. The returned object will complete after the whole response (including content) is read. > [!NOTE] -> In case of timeout, an that nests a is thrown. +> In case of timeout, an that nests a is thrown. (On .NET Core versions, without any inner exception is thrown.) + ]]> The is not an absolute URI and isn't set. diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index 480824bada9..ba090c4c6dd 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -242,6 +242,8 @@ This method populates the instance with data ga > [!NOTE] > If this constructor throws a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> The combination of and results in an invalid socket. @@ -298,7 +300,10 @@ This method populates the instance with data ga The `addressFamily` parameter specifies the addressing scheme that the class uses, the `socketType` parameter specifies the type of the class, and the `protocolType` parameter specifies the protocol used by . The three parameters are not independent. Some address families restrict which protocols can be used with them, and often the type is implicit in the protocol. If the combination of address family, type, and protocol type results in an invalid , this constructor throws a . > [!NOTE] -> If this constructor throws a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If this constructor throws a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates how to create an instance of the class. @@ -367,7 +372,10 @@ This method populates the instance with data ga If you call this method using a non-blocking , and no connection requests are queued, throws a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> Before calling the method, you must first call the method to listen for and queue incoming connection requests. +> Before calling the method, you must first call the method to listen for and queue incoming connection requests. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example accepts a simple connection. @@ -755,6 +763,9 @@ This method populates the instance with data ga If the remote host shuts down or closes the connection, can throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example compares the results of calling IOControl with FIONREAD and the Available property. @@ -847,13 +858,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> You can use the property of the returned to identify the remote host's network address and port number. +> You can use the property of the returned to identify the remote host's network address and port number. + +> [!NOTE] +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -939,13 +953,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> You can use the property of the returned to identify the remote host's network address and port number. +> You can use the property of the returned to identify the remote host's network address and port number. + +> [!NOTE] +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1035,13 +1052,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> You can use the property of the returned to identify the remote host's network address and port number. +> You can use the property of the returned to identify the remote host's network address and port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1148,13 +1168,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> You can use the property of the returned to identify the remote host's network address and port number. +> You can use the property of the returned to identify the remote host's network address and port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. + +> [!NOTE] +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1255,13 +1278,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. +> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1364,13 +1390,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. +> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1473,13 +1502,16 @@ This method populates the instance with data ga To cancel a pending call to the method, close the . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. + +> [!NOTE] +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1566,7 +1598,7 @@ This method populates the instance with data ga The operation must be completed by calling the method. Typically, the method is invoked by the provided delegate. will block the calling thread until the operation is completed. > [!NOTE] -> If you receive a exception, use the property to obtain the specific error code. +> If you receive a exception, use the property to obtain the specific error code. ]]> @@ -1659,16 +1691,19 @@ This method populates the instance with data ga Close the to cancel a pending . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1757,16 +1792,19 @@ This method populates the instance with data ga Close the to cancel a pending . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1865,16 +1903,19 @@ This method populates the instance with data ga Close the to cancel a pending . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -1981,16 +2022,19 @@ This method populates the instance with data ga Close the to cancel a pending . When the method is called while an asynchronous operation is in progress, the callback provided to the method is called. A subsequent call to the method will throw an (before .NET 7) or a (on .NET 7+) to indicate that the operation has been cancelled. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> `state` is an instantiation of a user-defined class. + +> [!NOTE] +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2115,10 +2159,13 @@ This method populates the instance with data ga To cancel a pending , call the method. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2237,10 +2284,13 @@ This method populates the instance with data ga This method reads data into the `buffer` parameter, and captures the remote host endpoint from which the data is sent, as well as information about the received packet. For information on how to retrieve this endpoint, refer to . This method is most useful if you intend to asynchronously receive connectionless datagrams from an unknown host or multiple hosts. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2355,19 +2405,22 @@ This method populates the instance with data ga If you specify the flag as the `socketflags` parameter, the data you are sending will not be routed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2458,19 +2511,22 @@ This method populates the instance with data ga If you specify the flag as the `socketflags` parameter, the data you are sending will not be routed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2571,19 +2627,22 @@ This method populates the instance with data ga If you specify the flag as the `socketflags` parameter, the data you are sending will not be routed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2690,19 +2749,22 @@ This method populates the instance with data ga If you specify the flag as the `socketflags` parameter, the data you are sending will not be routed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> `state` is an instantiation of a user-defined class. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> `state` is an instantiation of a user-defined class. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2811,10 +2873,10 @@ This method populates the instance with data ga Although intended for connection-oriented protocols, also works for connectionless protocols, provided that you first call the or method to establish a default remote host. With connectionless protocols, you must be sure that the size of your file does not exceed the maximum packet size of the underlying service provider. If it does, the datagram is not sent and throws a exception. > [!NOTE] -> If you receive a exception, use the property to obtain the specific error code. +> If you receive a exception, use the property to obtain the specific error code. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -2900,10 +2962,10 @@ This method populates the instance with data ga Although intended for connection-oriented protocols, also works for connectionless protocols, provided that you first call the or method to establish a default remote host. With connectionless protocols, you must be sure that the size of your file does not exceed the maximum packet size of the underlying service provider. If it does, the datagram is not sent and throws a exception. > [!NOTE] -> If you receive a exception, use the property to obtain the specific error code. +> If you receive a exception, use the property to obtain the specific error code. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -3006,10 +3068,10 @@ This method populates the instance with data ga If you specify the flag as the `socketflags` parameter, the data you are sending will not be routed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. ]]> @@ -3100,13 +3162,13 @@ This method populates the instance with data ga If a UDP socket wants to receive interface information on received packets, the method should be explicitly called with the socket option set to immediately after calling the method. > [!NOTE] -> If you intend to receive multicast datagrams, you must call the method with a multicast port number. +> If you intend to receive multicast datagrams, you must call the method with a multicast port number. > [!NOTE] -> You must call the method if you intend to receive connectionless datagrams using the method. +> You must call the method if you intend to receive connectionless datagrams using the method. > [!NOTE] -> If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -3180,7 +3242,7 @@ This method populates the instance with data ga If you are in blocking mode, and you make a method call that does not complete immediately, your application will block execution until the requested operation completes. If you want execution to continue even though the requested operation is not complete, change the property to `false`. The property has no effect on asynchronous methods. If you are sending and receiving data asynchronously and want to block execution, use the class. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -3303,7 +3365,7 @@ This method populates the instance with data ga If you need to call without first calling , you can ensure that data queued for outgoing transmission will be sent by setting the option to `false` and specifying a non-zero time-out interval. will then block until this data is sent or until the specified time-out expires. If you set to `false` and specify a zero time-out interval, releases the connection and automatically discards outgoing queued data. > [!NOTE] -> To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time out period. Use this along with the socket option to call the method. +> To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time out period. Use this along with the socket option to call the method. @@ -3371,7 +3433,7 @@ This method populates the instance with data ga If you need to call without first calling , you can ensure that data queued for outgoing transmission will be sent by setting the option to `false` and specifying a non-zero time-out interval. will then block until this data is sent or until the specified time-out expires. If you set to `false` and specify a zero time-out interval, releases the connection and automatically discards outgoing queued data. > [!NOTE] -> To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time-out period. Use this along with the socket option to call the method. +> To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time-out period. Use this along with the socket option to call the method. @@ -3451,10 +3513,10 @@ This method populates the instance with data ga The method will block, unless you specifically set the property to `false` prior to calling . If you are using a connection-oriented protocol like TCP and you do disable blocking, will throw a because it needs time to make the connection. Connectionless protocols will not throw an exception because they simply establish a default remote host. You can use to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. If the error returned WSAEWOULDBLOCK, the remote host connection has been initiated by a connection-oriented , but has not yet completed successfully. Use the method to determine when the is finished connecting. > [!NOTE] -> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. +> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. > [!NOTE] -> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. @@ -3537,10 +3599,10 @@ This method populates the instance with data ga method will block, unless you specifically set the property to `false` prior to calling . If you are using a connection-oriented protocol like TCP and you do disable blocking, will throw a because it needs time to make the connection. Connectionless protocols will not throw an exception because they simply establish a default remote host. You can use to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. If the error returned WSAEWOULDBLOCK, the remote host connection has been initiated by a connection-oriented , but has not yet completed successfully. Use the method to determine when the is finished connecting. > [!NOTE] -> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. +> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. > [!NOTE] -> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3614,10 +3676,10 @@ This method populates the instance with data ga method will block, unless you specifically set the property to `false` prior to calling . If you are using a connection-oriented protocol like TCP and you do disable blocking, will throw a because it needs time to make the connection. Connectionless protocols will not throw an exception because they simply establish a default remote host. You can use to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. If the error returned WSAEWOULDBLOCK, the remote host connection has been initiated by a connection-oriented , but has not yet completed successfully. Use the method to determine when the is finished connecting. > [!NOTE] -> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. +> If you are using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. > [!NOTE] -> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3693,10 +3755,10 @@ This method populates the instance with data ga If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you're using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. +> If you're using a connection-oriented protocol and did not call before calling , the underlying service provider will assign the local network address and port number. If you are using a connectionless protocol, the service provider will not assign a local network address and port number until you complete a send or receive operation. If you want to change the default remote host, call again with the desired endpoint. > [!NOTE] -> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3840,7 +3902,7 @@ This method populates the instance with data ga The method throws if the address family of the and the are not the same address family. > [!NOTE] -> If you receive a when calling this method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a when calling this method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -4223,7 +4285,7 @@ This method populates the instance with data ga The method throws if the address family of the and the are not the same address family. > [!NOTE] -> If you receive a when calling this method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a when calling this method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -4442,7 +4504,7 @@ This method populates the instance with data ga If you need to call without first calling , you can set the option to `false` and specify a nonzero time-out interval to ensure that data queued for outgoing transmission is sent. then blocks until the data is sent or until the specified time-out expires. If you set to `false` and specify a zero time-out interval, releases the connection and automatically discards outgoing queued data. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -4616,7 +4678,7 @@ This method populates the instance with data ga For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). > [!NOTE] -> Always call `Dispose` before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call `Dispose` before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -4985,6 +5047,9 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -5063,6 +5128,9 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -5138,6 +5206,9 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -5207,6 +5278,9 @@ Duplication of the socket reference failed. > [!NOTE] > If you receive a , use the property to obtain the specific error code. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -5276,7 +5350,10 @@ Duplication of the socket reference failed. completes the operation started by . You need to pass the created by the matching call. will block the calling thread until the operation is completed. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5359,10 +5436,13 @@ Duplication of the socket reference failed. The method will block until data is available. If you are using a connectionless protocol, will read the first enqueued datagram available in the incoming network buffer. If you are using a connection-oriented protocol, the method will read as much data as is available up to the number of bytes you specified in the `size` parameter of the method. If the remote host shuts down the connection with the method, and all available data has been received, the method will complete immediately and return zero bytes. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. + +> [!NOTE] +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. ]]> @@ -5440,10 +5520,13 @@ Duplication of the socket reference failed. The method will block until data is available. If you are using a connectionless protocol, will read the first enqueued datagram available in the incoming network buffer. If you are using a connection-oriented protocol, the method will read as much data as is available up to the number of bytes you specified in the `size` parameter of the method. If the remote host shuts down the connection with the method, and all available data has been received, the method will complete immediately and return zero bytes. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. ]]> @@ -5522,7 +5605,10 @@ Duplication of the socket reference failed. The method will block until data is available. If you are using a connectionless protocol, will read the first enqueued datagram available in the incoming network buffer. If you are using a connection-oriented protocol, the method will read as much data as is available up to the number of bytes you specified in the `size` parameter of the method. If the remote host shuts down the connection with the method, and all available data has been received, the method will complete immediately and return zero bytes. To obtain the received data, call the method of the object, and extract the buffer contained in the resulting state object. To identify the originating host, extract the and cast it to an . Use the method to obtain the IP address and the method to obtain the port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5599,7 +5685,10 @@ Duplication of the socket reference failed. Examine `ipPacketInformation` if you need to know if the datagram was sent using a unicast, multicast, or broadcast address. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5687,13 +5776,16 @@ Duplication of the socket reference failed. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. + +> [!NOTE] +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. ]]> @@ -5773,13 +5865,16 @@ Duplication of the socket reference failed. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. +> If you receive a , use the property to obtain the specific error code. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5927,7 +6022,7 @@ Duplication of the socket reference failed. If you are using a connectionless protocol, will block until the datagram is sent. If you are using a connection-oriented protocol, will block until the requested number of bytes are sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -6171,7 +6266,7 @@ In general, the `GetSocketOption` method should be used whenever getting a options determine the behavior of the current . Use this overload to get the , , and options. For the option, use for the `optionLevel` parameter. For and , use . If you want to set the value of any of the options listed above, use the method. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -6325,7 +6420,7 @@ In general, the `GetSocketOption` method should be used whenever getting a will throw a . Use this overload for any sockets that are represented by Boolean values or integers. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -6456,7 +6551,7 @@ In general, the `GetSocketOption` method should be used whenever getting a method provides low-level access to the operating system underlying the current instance of the class. For more information, see the [WSAIoctl](/windows/win32/api/winsock2/nf-winsock2-wsaioctl) documentation. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -6528,7 +6623,7 @@ In general, the `GetSocketOption` method should be used whenever getting a underlying the current instance of the class. For more, see the [WSAIoctl](/windows/win32/api/winsock2/nf-winsock2-wsaioctl) documentation. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -6774,10 +6869,10 @@ The maximum length of the pending connections queue is determined automatically. If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. Use or to accept a connection from the queue. > [!NOTE] -> You must call the method before calling , or will throw a . +> You must call the method before calling , or will throw a . > [!NOTE] -> The backlog parameter is limited to different values depending on the Operating System. You may specify a higher value, but the backlog will be limited based on the Operating System. +> The backlog parameter is limited to different values depending on the Operating System. You may specify a higher value, but the backlog will be limited based on the Operating System. @@ -6852,7 +6947,7 @@ The maximum length of the pending connections queue is determined automatically. The property is usually set after you make a call to the method. If you allow the system to assign your socket's local IP address and port number, the property will be set after the first I/O operation. For connection-oriented protocols, the first I/O operation would be a call to the or method. For connectionless protocols, the first I/O operation would be any of the send or receive calls. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -7180,10 +7275,10 @@ The maximum length of the pending connections queue is determined automatically. The method checks the state of the . Specify for the `selectMode` parameter to determine if the is readable. Specify to determine if the is writable. Use to detect an error condition. will block execution until the specified time period, measured in `microseconds`, elapses or data becomes available. Set the `microSeconds` parameter to a negative integer if you would like to wait indefinitely for a response. If you want to check the status of multiple sockets, you might prefer to use the method. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. +> This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. ## Examples The following code example creates a socket, connects to a server, and uses to check the status of the socket. @@ -7368,7 +7463,7 @@ The maximum length of the pending connections queue is determined automatically. If you are using a connectionless , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -7459,7 +7554,7 @@ The maximum length of the pending connections queue is determined automatically. If you are using a connectionless , will read the first enqueued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffers` parameter, `buffers` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -7597,7 +7692,7 @@ If you're using a connectionless , , will read the first enqueued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -7690,7 +7785,7 @@ If you're using a connectionless , , will read the first enqueued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffers` parameter, `buffers` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -7849,7 +7944,7 @@ If you're using a connectionless , , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -7946,7 +8041,7 @@ If you're using a connectionless , , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffers` parameter, `buffers` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -8021,7 +8116,7 @@ If you're using a connection-oriented , the , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -8100,7 +8195,7 @@ If you're using a connectionless , , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -8699,7 +8794,7 @@ If you're using a connectionless , that represents the remote host. The buffer offset defaults to 0. The size defaults to the length of the `buffer` parameter and the `socketFlags` value defaults to . > [!NOTE] -> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . +> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . With connectionless protocols, will read the first enqueued datagram received into the local network buffer. If the datagram you receive is larger than the size of `buffer`, the method will fill `buffer` with as much of the message as is possible, and throw a . If you are using an unreliable protocol, the excess data will be lost. If you are using a reliable protocol, the excess data will be retained by the service provider and you can retrieve it by calling the method with a large enough buffer. @@ -8710,10 +8805,10 @@ If you're using a connectionless , will read as much data as is available up to the size of `buffer`. If the remote host shuts down the connection with the method, and all available data has been received, the method will complete immediately and return zero bytes. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The of the used in needs to match the of the used in . +> The of the used in needs to match the of the used in . @@ -8844,7 +8939,7 @@ If you're using a connectionless , , and an that represents the remote host. The offset defaults to 0 and the size defaults to the length of the buffer parameter. > [!NOTE] -> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . +> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . With connectionless protocols, will read the first enqueued datagram received into the local network buffer. If the datagram you receive is larger than the size of `buffer`, the method will fill `buffer` with as much of the message as is possible, and throw a . If you are using an unreliable protocol, the excess data will be lost. If you are using a reliable protocol, the excess data will be retained by the service provider and you can retrieve it by calling the method with a large enough buffer. @@ -8855,10 +8950,10 @@ If you're using a connectionless , will read as much data as is available up to the size of `buffer`. If the remote host shuts down the connection with the method, and all available data has been Received, the method will complete immediately and return zero bytes. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The of the used in needs to match the of the used in . +> The of the used in needs to match the of the used in . @@ -9048,10 +9143,10 @@ If you're using a connectionless , will read as much data as is available up to the number of bytes specified by the `size` parameter. If the remote host shuts down the connection with the method, and all available data has been received, the method will complete immediately and return zero bytes. > [!NOTE] -> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The of the used in needs to match the of the used in . +> The of the used in needs to match the of the used in . @@ -9162,10 +9257,10 @@ If you're using a connectionless , will read as much data as is available up to the amount of bytes specified by the `size` parameter. If the remote host shuts down the connection with the method, and all available data has been Received, the method will complete immediately and return zero bytes. > [!NOTE] -> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> Before calling , you must explicitly bind the to a local endpoint using the method. If you do not, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The of the used in needs to match the of the used in . +> The of the used in needs to match the of the used in . @@ -9668,7 +9763,7 @@ You must call the Bind method before performing this operation. An application can examine the `ipPacketInformation` parameter if it needs to know if the datagram was sent using a unicast, multicast, or broadcast address. > [!NOTE] -> The of the used in needs to match the of the used in . +> The of the used in needs to match the of the used in . ]]> @@ -10229,13 +10324,13 @@ You must call the Bind method before performing this operation. If you have made a non-blocking call to , the `checkerror` parameter identifies sockets that have not connected successfully. > [!NOTE] -> Use the method if you only want to determine the status of a single . +> Use the method if you only want to determine the status of a single . > [!NOTE] -> This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. +> This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. @@ -10368,12 +10463,13 @@ You must call the Bind method before performing this operation. If you are using a connection-oriented protocol, will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. - +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates sending data on a connected . @@ -10458,10 +10554,13 @@ You must call the Bind method before performing this operation. If you are using a connection-oriented protocol, will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -10600,12 +10699,13 @@ If you're using a connection-oriented protocol, will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the requested number of bytes. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> You must ensure that the size of your buffer does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> You must ensure that the size of your buffer does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. - +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates sending data on a connected . @@ -10690,10 +10790,13 @@ If you're using a connection-oriented protocol, will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In non-blocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -10918,10 +11021,13 @@ The following code example sends the data found in buffer, and specifies will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In non-blocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -11069,12 +11175,13 @@ If you're using a connection-oriented protocol, will block until the requested number of bytes are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes you request. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the requested number of bytes. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. - +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example specifies the data buffer, an offset, a size, and for sending data to a connected . @@ -11181,12 +11288,13 @@ If you're using a connection-oriented protocol, will block until the requested number of bytes are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes you request. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the requested number of bytes. There is also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. - +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example specifies the data buffer, an offset, a size, and for sending data to a connected . @@ -11685,7 +11793,7 @@ If you're using a connection-oriented protocol, blocks until the file is sent. In nonblocking mode, may complete successfully before the entire file has been sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example creates and connects a socket and then sends a file to the remote host. The file "test.txt" is located in the root directory of the local machine. @@ -11766,7 +11874,7 @@ If you're using a connection-oriented protocol, blocks until the entire file is sent. In nonblocking mode, may complete successfully before the entire file has been sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example creates and connects a socket. The file "test.txt" is located in the root directory of the local machine. In this example, we create a prebuffer and postbuffer of data and send them to the remote host with the file. The default are used. @@ -12145,7 +12253,7 @@ If you're using a connection-oriented protocol, will block until the datagram is sent. If you want to send data to a broadcast address, you must first call the method and set the socket option to . You must also be sure that the number of bytes sent does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sends a connectionless datagram to the specified remote host. @@ -12280,7 +12388,7 @@ If you're using a connection-oriented protocol, will block until the datagram is sent. If you want to send data to a broadcast address, you must first call the method and set the socket option to . You must also be sure that the number of bytes sent does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sends a connectionless datagram to the specified remote host. are passed to the method. @@ -12465,7 +12573,7 @@ If you're using a connection-oriented protocol, will block until the datagram is sent. If you want to send data to a broadcast address, you must first call the method and set the socket option to . You must also be sure that the number of bytes sent does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sends a connectionless datagram to the specified remote host. The size and are passed to the method. @@ -12559,7 +12667,7 @@ If you're using a connection-oriented protocol, will block until the datagram is sent. If you want to send data to a broadcast address, you must first call the method and set the socket option to . You must also be sure that the size does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and will throw a . > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sends a connectionless datagram to the specified remote host. The offset, size, and are passed to the method. @@ -13161,7 +13269,7 @@ The enumeration. > [!NOTE] -> If you receive a exception, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a exception, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example opens a socket and enables the `DontLinger` and the `OutOfBandInline` socket options. @@ -13228,7 +13336,7 @@ The options determine the behavior of the current . Use this overload to set those options that require a byte array as an option value. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sets the and time-out values. @@ -13365,7 +13473,7 @@ The enumeration. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sets the and time-out values. @@ -13436,7 +13544,7 @@ The options determine the behavior of the current . Use this overload to set the , , and options. For the option, use for the `optionLevel` parameter. For and , use . If you want to get the current value of any of the options listed above, use the method. > [!NOTE] -> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example sets the and time out values. @@ -13527,7 +13635,7 @@ The disables both sends and receives as described above. > [!NOTE] -> If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ## Examples The following code example uses to disable the . diff --git a/xml/System.Net.Sockets/SocketAsyncEventArgs.xml b/xml/System.Net.Sockets/SocketAsyncEventArgs.xml index d9c7332400d..2cbb8e889d6 100644 --- a/xml/System.Net.Sockets/SocketAsyncEventArgs.xml +++ b/xml/System.Net.Sockets/SocketAsyncEventArgs.xml @@ -759,6 +759,9 @@ When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index 33cae15c70a..2188c515de0 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -69,7 +69,7 @@ - Create a `TcpClient` using the host name and port number of the remote host. This constructor will automatically attempt a connection. > [!NOTE] -> If you want to send connectionless datagrams in synchronous blocking mode, use the class. +> If you want to send connectionless datagrams in synchronous blocking mode, use the class. @@ -147,6 +147,12 @@ ## Remarks This constructor creates a new and allows the underlying service provider to assign the most appropriate local IP address and port number. You must first call the method before sending and receiving data. +> [!NOTE] +> On .NET Framework, this constructor works only with IPv4 address types. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates how to use the parameterless constructor to create a new . @@ -205,6 +211,9 @@ You must call the method before sending and receiving data. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates how to create an instance of the class using a local endpoint. @@ -261,6 +270,11 @@ [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates how to create an instance of the class. @@ -326,7 +340,10 @@ If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates how to create an instance of the class using a host name and port number. @@ -827,6 +844,9 @@ The `Available` property is a way to determine whether data is queued for readin Calling this method will eventually result in the close of the associated `Socket` and will also close the associated that is used to send and receive data if one was created. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates closing a by calling the `Close` method. @@ -897,6 +917,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -966,7 +989,12 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified and port number. The method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1036,7 +1064,12 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call the `Connect` method to establish a synchronous remote host connection to the host specified by the array of elements and the port number. The `Connect` method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1109,7 +1142,10 @@ The `Available` property is a way to determine whether data is queued for readin If IPv6 is enabled and the `Connect(String, Int32)` method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example uses the host name and port number to connect with a remote host. @@ -1179,6 +1215,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a , use to obtain the specific error code. After you've obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + > [!NOTE] > If you receive a `NotSupportedException` with the message "This protocol version is not supported" while using IPv6 address, make sure you enabled IPv6 in the constructor by passing . @@ -1241,7 +1280,12 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified and port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1309,7 +1353,12 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of elements and the port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1366,7 +1415,12 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified . Before you call `Connect`, you must create an instance of the `IPEndPoint` class using an IP address and a port number. Use this `IPEndPoint` as the `remoteEP` parameter. The `Connect` method will block until it either connects or fails. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1431,7 +1485,12 @@ The `Available` property is a way to determine whether data is queued for readin If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1488,7 +1547,12 @@ The `Available` property is a way to determine whether data is queued for readin Call this method to establish a synchronous remote host connection to the specified IP address and port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1548,7 +1612,12 @@ The `Available` property is a way to determine whether data is queued for readin This method is typically used immediately after a call to the method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of IP addresses and the port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error.> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + +> [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1611,7 +1680,12 @@ The `Available` property is a way to determine whether data is queued for readin If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1777,7 +1851,12 @@ The `Available` property is a way to determine whether data is queued for readin ## Remarks This method is called by the public `Dispose()` method and the method, if it has been overridden. `Dispose()` invokes this method with the `disposing` parameter set to `true`. `Finalize` invokes this method with `disposing` set to `false`. - When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. It does this by invoking the `Dispose()` method of each referenced object. ]]> + When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. It does this by invoking the `Dispose()` method of each referenced object. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> @@ -1835,7 +1914,7 @@ The `Available` property is a way to determine whether data is queued for readin This method blocks until the operation is complete. To perform this operation synchronously, use a method. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. ]]> @@ -2011,7 +2090,10 @@ The `GetStream` method returns a that yo You must call the method first, or the method will throw an . After you have obtained the `NetworkStream`, call the method to send data to the remote host. Call the method to receive data arriving from the remote host. Both of these methods block until the specified operation is performed. You can avoid blocking on a read operation by checking the property. A `true` value means that data has arrived from the remote host and is available for reading. In this case, is guaranteed to complete immediately. If the remote host has shutdown its connection, will immediately return with zero bytes. > [!NOTE] -> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example uses `GetStream` to obtain the underlying . After obtaining the , it sends and receives using its and methods. diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 4a2cf12f823..552ffca141f 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -72,7 +72,7 @@ Call the method to close the . > [!NOTE] -> The method does not close any accepted connections. You are responsible for closing these separately. +> The method does not close any accepted connections. You are responsible for closing these separately. @@ -219,6 +219,9 @@ Call the method to begin listening for incoming connection attempts. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example creates an instance of the class using the local endpoint. @@ -283,6 +286,9 @@ Call the method to begin listening for incoming connection attempts. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example creates an instance of the class using a local IP address and port number. @@ -347,6 +353,9 @@ The returned is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples In the following code example, the method is used to return a . This is used to communicate with the newly connected client. @@ -406,7 +415,10 @@ ## Remarks This operation will not block. The returned object will complete after the socket connection has been accepted. - The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -460,7 +472,8 @@ The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -515,6 +528,9 @@ Use the method to obtain the underlying of the returned . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using . +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples In the following code example, the method is used to return a . This is used to communicate with the newly connected client. @@ -578,7 +594,8 @@ Use the method to obtain the underlying of the returned in the . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using or . - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -634,7 +651,8 @@ Use the method to obtain the underlying of the returned in the . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using or . - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -825,12 +843,13 @@ For detailed information about using the asynchronous programming model, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). > [!NOTE] -> You can call the property of the returned to identify the remote host's network address and port number. +> You can call the property of the returned to identify the remote host's network address and port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> An error occurred while attempting to access the socket. The has been closed. @@ -898,9 +917,10 @@ For detailed information about using the asynchronous programming model, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). > [!NOTE] -> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> An error occurred while attempting to access the socket. The has been closed. @@ -1031,12 +1051,13 @@ This method blocks until the operation is complete. To perform this operation synchronously, use the method. > [!NOTE] -> You can call the property of the returned to identify the remote host's network address and port number. +> You can call the property of the returned to identify the remote host's network address and port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> The underlying has been closed. The parameter is . @@ -1096,12 +1117,13 @@ This method blocks until the operation is complete. To perform this operation synchronously, use the method. > [!NOTE] -> You can call the property of the underlying socket () to identify the remote host's network address and port number. +> You can call the property of the underlying socket () to identify the remote host's network address and port number. > [!NOTE] -> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> If you receive a , use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -1340,7 +1362,7 @@ creates a to listen for incoming client connection requests. Classes deriving from can use this property to get this . Use the underlying returned by the property if you require access beyond that which provides. > [!NOTE] -> The property only returns the used to listen for incoming client connection requests. Use the method to accept a pending connection request and obtain a for sending and receiving data. You can also use the method to accept a pending connection request and obtain a for sending and receiving data. +> The property only returns the used to listen for incoming client connection requests. Use the method to accept a pending connection request and obtain a for sending and receiving data. You can also use the method to accept a pending connection request and obtain a for sending and receiving data. @@ -1417,6 +1439,9 @@ Use the method to close the and stop listening. You are responsible for closing your accepted connections separately. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates how is used to listen for incoming client connection attempts. @@ -1485,7 +1510,10 @@ Use the method to close the and stop listening. You are responsible for closing your accepted connections separately. > [!NOTE] -> Use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> Use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates how is used to listen for incoming client connection attempts. @@ -1551,6 +1579,9 @@ ## Remarks closes the listener. Any unaccepted connection requests in the queue will be lost. Remote hosts waiting for a connection to be accepted will throw a . You are responsible for closing your accepted connections separately. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example demonstrates using the method to close the underlying . From 24151654420151eb261d905c9b15a28a56fabb2a Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 22 May 2026 15:48:46 -0700 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Cache/HttpRequestCacheLevel.xml | 2 +- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- xml/System.Net.Security/SslStream.xml | 6 +++--- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Net.Cache/HttpRequestCacheLevel.xml b/xml/System.Net.Cache/HttpRequestCacheLevel.xml index b2259c3c3fa..76ff4f50d5c 100644 --- a/xml/System.Net.Cache/HttpRequestCacheLevel.xml +++ b/xml/System.Net.Cache/HttpRequestCacheLevel.xml @@ -97,7 +97,7 @@ 1 - Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. No entries are taken from caches, added to caches, or removed from caches between the client and server. + Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 16252503ce1..068255b8ec9 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -949,7 +949,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r Gets or sets how long a connection can be idle in the pool to be considered reusable. - The maximum idle time for a connection in the pool. The default value is 1 minute. + The maximum idle time for a connection in the pool. The default value for this property is 1 minute in .NET 6 and later versions; the default value is 2 minutes in .NET Core and .NET 5. To be added. The value specified is less than and is not . An operation has already been started on the current instance. diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 1bf455ee238..23464a9152f 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -48,7 +48,7 @@ ## Remarks This property bag is used as argument for and . - The uses this property bag in the property. +The uses this property bag in the property. ]]> diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 922c3c34e10..af58b868361 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -89,7 +89,7 @@ To opt out of the behavior that blocks insecure cipher and hashing algorithms for connections in order to maintain interoperability with your existing SSL3 services OR TLS w/ RC4 services, see [Cannot connect to a server by using the ServicePointManager or SslStream APIs after upgrade to the .NET Framework 4.6](https://support.microsoft.com/kb/3069494). -Use the the overloads for methods that authenticate SslStreams that don't specify a TLS version, but instead use the TLS version defined as the system default in [SCHANNEL](/windows/win32/secauthn/secure-channel), as a way to be able to later modify the defaults, without the need to rebuild and redeploy your app. +Use the overloads for methods that authenticate SslStreams that don't specify a TLS version, but instead use the TLS version defined as the system default in [SCHANNEL](/windows/win32/secauthn/secure-channel), as a way to be able to later modify the defaults, without the need to rebuild and redeploy your app. ## Examples The following code example demonstrates creating an that uses the class to communicate with clients. @@ -331,7 +331,7 @@ Use the the overloads for methods that authenticate SslStreams that don't specif The use of the Null cipher is required when the encryption policy is set to . > [!NOTE] -> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. +> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous session if the certificate collection is empty. > [!NOTE] > Client certificates are not supported in the SSL version 2 protocol. @@ -428,7 +428,7 @@ Use the the overloads for methods that authenticate SslStreams that don't specif The use of the Null cipher is required when the encryption policy is set to . > [!NOTE] -> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous sessions if the certificate collection is empty. +> .NET caches SSL sessions as they are created and attempts to reuse a cached session for subsequent requests, if possible. When attempting to reuse an SSL session, .NET uses the first element of the provided during authentication (if there is one), or tries to reuse an anonymous session if the certificate collection is empty. ## Examples The following code example demonstrates calling this constructor. This example is part of a larger example provided for the class. From 7d754f4019a5b51161eb82838ddbf832ccbd0f84 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 22 May 2026 18:39:35 -0700 Subject: [PATCH 5/5] more fixups --- xml/System.Net.Security/SslStream.xml | 2 +- xml/System.Net.Sockets/Socket.xml | 1449 ++++++++++++----------- xml/System.Net.Sockets/TcpClient.xml | 27 +- xml/System.Net.WebSockets/WebSocket.xml | 4 +- 4 files changed, 774 insertions(+), 708 deletions(-) diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 922c3c34e10..8b8c391521d 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -87,7 +87,7 @@ assumes that a timeout along with any other when one is thrown from the inner stream will be treated as fatal by its caller. Reusing a instance after a timeout will return garbage. An application should the and throw an exception in these cases. -To opt out of the behavior that blocks insecure cipher and hashing algorithms for connections in order to maintain interoperability with your existing SSL3 services OR TLS w/ RC4 services, see [Cannot connect to a server by using the ServicePointManager or SslStream APIs after upgrade to the .NET Framework 4.6](https://support.microsoft.com/kb/3069494). +To opt out of the behavior that blocks insecure cipher and hashing algorithms for connections in order to maintain interoperability with your existing SSL3 services OR TLS w/ RC4 services, see [Cannot connect to a server by using the ServicePointManager or SslStream APIs after upgrade to .NET Framework 4.6](https://support.microsoft.com/kb/3069494). Use the the overloads for methods that authenticate SslStreams that don't specify a TLS version, but instead use the TLS version defined as the system default in [SCHANNEL](/windows/win32/secauthn/secure-channel), as a way to be able to later modify the defaults, without the need to rebuild and redeploy your app. diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index ba090c4c6dd..bb363683510 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -119,7 +119,7 @@ implementation, this may lead to unintended data interleaving for large or multi - The socket handle for the socket that the object will encapsulate. + The socket handle for the socket that the object will encapsulate. Initializes a new instance of the class for the specified socket handle. instance with data ga - The socket information returned by . + The socket information returned by . Initializes a new instance of the class using the specified value returned from . instance with data ga > [!NOTE] > This member outputs trace information when you enable network tracing in your application. + ]]> - The combination of and results in an invalid socket. + The combination of and results in an invalid socket. @@ -313,7 +314,7 @@ This method populates the instance with data ga ]]> - The combination of , , and results in an invalid socket. + The combination of , , and results in an invalid socket. @@ -386,8 +387,8 @@ This method populates the instance with data ga ]]> An error occurred when attempting to access the socket. - The has been closed. - The accepting socket is not listening for connections. You must call and before calling . + The has been closed. + The accepting socket is not listening for connections. You must call and before calling . @@ -425,7 +426,7 @@ This method populates the instance with data ga You must call the and method before calling the method. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -462,7 +463,7 @@ This method populates the instance with data ga - The socket to use for accepting the connection. + The socket to use for accepting the connection. Accepts an incoming connection. An asynchronous task that completes with the accepted Socket. To be added. @@ -470,7 +471,7 @@ This method populates the instance with data ga You must call the and method before calling the method. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -513,7 +514,7 @@ This method populates the instance with data ga - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins an asynchronous operation to accept an incoming connection attempt. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -529,7 +530,7 @@ This method populates the instance with data ga The following properties and events on the object are required: -- +- The caller can optionally specify an existing to use for the incoming connection by specifying the to use with the property. @@ -555,7 +556,7 @@ This method populates the instance with data ga This exception also occurs if the socket is already connected or a socket operation was already in progress using the specified parameter. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -605,8 +606,8 @@ This method populates the instance with data ga You must call the and method before calling the method. An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -643,7 +644,7 @@ This method populates the instance with data ga - The socket to use for accepting the connection. + The socket to use for accepting the connection. A cancellation token that can be used to cancel the asynchronous operation. Accepts an incoming connection. An asynchronous task that completes with the accepted Socket. @@ -652,8 +653,8 @@ This method populates the instance with data ga You must call the and method before calling the method. An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -754,7 +755,7 @@ This method populates the instance with data ga Gets the amount of data that has been received from the network and is available to be read. - The number of bytes of data received from the network and available to be read. + The number of bytes of data received from the network and available to be read. instance with data ga ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -838,7 +839,7 @@ This method populates the instance with data ga - The delegate. + The delegate. An object that contains state information for this request. Begins an asynchronous operation to accept an incoming connection attempt. An that references the asynchronous creation. @@ -871,8 +872,8 @@ This method populates the instance with data ga ]]> - The object has been closed. - The accepting socket is not listening for connections. You must call and before calling . + The object has been closed. + The accepting socket is not listening for connections. You must call and before calling . -or- @@ -932,8 +933,8 @@ This method populates the instance with data ga - The number of bytes to accept from the sender. - The delegate. + The number of bytes to accept from the sender. + The delegate. An object that contains state information for this request. Begins an asynchronous operation to accept an incoming connection attempt and receives the first block of data sent by the client application. An that references the asynchronous creation. @@ -959,15 +960,15 @@ This method populates the instance with data ga > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. ]]> - The object has been closed. - The accepting socket is not listening for connections. You must call and before calling . + The object has been closed. + The accepting socket is not listening for connections. You must call and before calling . -or- @@ -1030,9 +1031,9 @@ This method populates the instance with data ga - The accepted object. This value may be . - The maximum number of bytes to receive. - The delegate. + The accepted object. This value may be . + The maximum number of bytes to receive. + The delegate. An object that contains state information for this request. Begins an asynchronous operation to accept an incoming connection attempt from a specified socket and receives the first block of data sent by the client application. An object that references the asynchronous object creation. @@ -1058,15 +1059,15 @@ This method populates the instance with data ga > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. ]]> - The object has been closed. - The accepting socket is not listening for connections. You must call and before calling . + The object has been closed. + The accepting socket is not listening for connections. You must call and before calling . -or- @@ -1148,7 +1149,7 @@ This method populates the instance with data ga An that represents the remote host. - The delegate. + The delegate. An object that contains state information for this request. Begins an asynchronous request for a remote host connection. An that references the asynchronous connection. @@ -1174,18 +1175,18 @@ This method populates the instance with data ga > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. ]]> is . - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The has been placed in a listening state by calling , or an asynchronous operation is already in progress. + The has been placed in a listening state by calling , or an asynchronous operation is already in progress. @@ -1252,8 +1253,8 @@ This method populates the instance with data ga - The of the remote host. - The port number of the remote host. + The of the remote host. + The port number of the remote host. An delegate that references the method to invoke when the connect operation is complete. A user-defined object that contains information about the connect operation. This object is passed to the delegate when the operation is complete. Begins an asynchronous request for a remote host connection. The host is specified by an and a port number. @@ -1280,24 +1281,24 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> is . - The has been closed. - The is not in the socket family. - The port number is not valid. - The length of is zero. - The has been placed in a listening state by calling , or an asynchronous operation is already in progress. + The has been closed. + The is not in the socket family. + The port number is not valid. + The length of is zero. + The has been placed in a listening state by calling , or an asynchronous operation is already in progress. @@ -1365,7 +1366,7 @@ This method populates the instance with data ga At least one , designating the remote host. - The port number of the remote host. + The port number of the remote host. An delegate that references the method to invoke when the connect operation is complete. A user-defined object that contains information about the connect operation. This object is passed to the delegate when the operation is complete. Begins an asynchronous request for a remote host connection. The host is specified by an array and a port number. @@ -1392,24 +1393,24 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> is . - The has been closed. + The has been closed. This method is valid for sockets that use or . - The port number is not valid. - The length of is zero. - The has been placed in a listening state by calling , or an asynchronous operation is already in progress. + The port number is not valid. + The length of is zero. + The has been placed in a listening state by calling , or an asynchronous operation is already in progress. @@ -1476,8 +1477,8 @@ This method populates the instance with data ga - The name of the remote host. - The port number of the remote host. + The name of the remote host. + The port number of the remote host. An delegate that references the method to invoke when the connect operation is complete. A user-defined object that contains information about the connect operation. This object is passed to the delegate when the operation is complete. Begins an asynchronous request for a remote host connection. The host is specified by a host name and a port number. @@ -1504,23 +1505,23 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > If this socket has previously been disconnected, then must be called on a thread that will not exit until the operation is complete. This is a limitation of the underlying provider. > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> is . - The has been closed. + The has been closed. This method is valid for sockets in the or families. - The port number is not valid. - The has been placed in a listening state by calling , or an asynchronous operation is already in progress. + The port number is not valid. + The has been placed in a listening state by calling , or an asynchronous operation is already in progress. @@ -1580,7 +1581,7 @@ This method populates the instance with data ga if this socket can be reused after the connection is closed; otherwise, . - The delegate. + The delegate. An object that contains state information for this request. Begins an asynchronous request to disconnect from a remote endpoint. An object that references the asynchronous operation. @@ -1600,9 +1601,12 @@ This method populates the instance with data ga > [!NOTE] > If you receive a exception, use the property to obtain the specific error code. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> - The object has been closed. + The object has been closed. @@ -1693,9 +1697,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -1705,6 +1706,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -1794,9 +1798,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -1806,6 +1807,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -1882,8 +1886,8 @@ This method populates the instance with data ga An array of type that is the storage location for the received data. - The zero-based position in the parameter at which to store the received data. - The number of bytes to receive. + The zero-based position in the parameter at which to store the received data. + The number of bytes to receive. A bitwise combination of the values. An delegate that references the method to invoke when the operation is complete. A user-defined object that contains information about the receive operation. This object is passed to the delegate when the operation is complete. @@ -1905,9 +1909,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -1917,6 +1918,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -2000,8 +2004,8 @@ This method populates the instance with data ga An array of type that is the storage location for the received data. - The location in to store the received data. - The number of bytes to receive. + The location in to store the received data. + The number of bytes to receive. A bitwise combination of the values. A object that stores the socket error. An delegate that references the method to invoke when the operation is complete. @@ -2024,9 +2028,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -2036,6 +2037,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -2127,11 +2131,11 @@ This method populates the instance with data ga An array of type that is the storage location for the received data. - The zero-based position in the parameter at which to store the data. - The number of bytes to receive. + The zero-based position in the parameter at which to store the data. + The number of bytes to receive. A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on synchronous receive. - The delegate. + The delegate. An object that contains state information for this request. Begins to asynchronously receive data from a specified network device. An that references the asynchronous read. @@ -2162,10 +2166,10 @@ This method populates the instance with data ga > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -2189,7 +2193,7 @@ This method populates the instance with data ga -or- is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -2260,11 +2264,11 @@ This method populates the instance with data ga An array of type that is the storage location for the received data. - The zero-based position in the parameter at which to store the data. - The number of bytes to receive. + The zero-based position in the parameter at which to store the data. + The number of bytes to receive. A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on synchronous receive. - The delegate. + The delegate. An object that contains state information for this request. Begins to asynchronously receive the specified number of bytes of data into the specified location of the data buffer, using the specified , and stores the endpoint and packet information. An that references the asynchronous read. @@ -2287,10 +2291,10 @@ This method populates the instance with data ga > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. > [!NOTE] -> The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -2314,7 +2318,7 @@ This method populates the instance with data ga -or- is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. @@ -2385,7 +2389,7 @@ This method populates the instance with data ga An array of type that contains the data to send. A bitwise combination of the values. - The delegate. + The delegate. An object that contains state information for this request. Sends data asynchronously to a connected . An that references the asynchronous send. @@ -2407,9 +2411,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -2422,13 +2423,16 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> is . is empty. - The has been closed. + The has been closed. @@ -2491,7 +2495,7 @@ This method populates the instance with data ga An array of type that contains the data to send. A bitwise combination of the values. A object that stores the socket error. - The delegate. + The delegate. An object that contains state information for this request. Sends data asynchronously to a connected . An that references the asynchronous send. @@ -2513,9 +2517,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -2528,13 +2529,16 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> is . is empty. - The has been closed. + The has been closed. @@ -2604,10 +2608,10 @@ This method populates the instance with data ga An array of type that contains the data to send. - The zero-based position in the parameter at which to begin sending data. - The number of bytes to send. + The zero-based position in the parameter at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. - The delegate. + The delegate. An object that contains state information for this request. Sends data asynchronously to a connected . An that references the asynchronous send. @@ -2629,9 +2633,6 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. @@ -2644,6 +2645,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -2662,7 +2666,7 @@ This method populates the instance with data ga -or- is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. @@ -2725,11 +2729,11 @@ This method populates the instance with data ga An array of type that contains the data to send. - The zero-based position in the parameter at which to begin sending data. - The number of bytes to send. + The zero-based position in the parameter at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. A object that stores the socket error. - The delegate. + The delegate. An object that contains state information for this request. Sends data asynchronously to a connected . An that references the asynchronous send. @@ -2754,9 +2758,6 @@ This method populates the instance with data ga > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > `state` is an instantiation of a user-defined class. @@ -2766,6 +2767,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -2784,7 +2788,7 @@ This method populates the instance with data ga -or- is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. @@ -2853,7 +2857,7 @@ This method populates the instance with data ga A string that contains the path and name of the file to send. This parameter can be . - The delegate. + The delegate. An object that contains state information for this request. Sends the file to a connected object using the flag. An object that represents the asynchronous send. @@ -2880,9 +2884,9 @@ This method populates the instance with data ga ]]> - The object has been closed. - The socket is not connected to a remote host. - The file was not found. + The object has been closed. + The socket is not connected to a remote host. + The file was not found. @@ -2937,8 +2941,8 @@ This method populates the instance with data ga A string that contains the path and name of the file to be sent. This parameter can be . - The data to be sent before the file is sent. This parameter can be . - The data to be sent after the file is sent. This parameter can be . + The data to be sent before the file is sent. This parameter can be . + The data to be sent after the file is sent. This parameter can be . A bitwise combination of the enumeration values. An delegate to be invoked when this operation completes. This parameter can be . A user-defined object that contains state information for this request. This parameter can be . @@ -2967,15 +2971,18 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> - The object has been closed. - The operating system is not Windows NT or later. + The object has been closed. + The operating system is not Windows NT or later. -or- The socket is not connected to a remote host. - The file was not found. + The file was not found. @@ -3040,11 +3047,11 @@ This method populates the instance with data ga An array of type that contains the data to send. - The zero-based position in at which to begin sending data. - The number of bytes to send. + The zero-based position in at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. An that represents the remote device. - The delegate. + The delegate. An object that contains state information for this request. Sends data asynchronously to a specific remote host. An that references the asynchronous send. @@ -3073,6 +3080,9 @@ This method populates the instance with data ga > [!NOTE] > The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous methods. After the first use of a particular context (a specific asynchronous method, a specific instance, and a specific callback), subsequent uses of that context will see a performance improvement. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -3095,7 +3105,7 @@ This method populates the instance with data ga -or- is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -3147,7 +3157,7 @@ This method populates the instance with data ga - The local to associate with the . + The local to associate with the . Associates a with a local endpoint. instance with data ga > [!NOTE] > If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example binds a using the specified local endpoint. @@ -3183,7 +3194,7 @@ This method populates the instance with data ga is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -3244,10 +3255,13 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -3289,7 +3303,7 @@ This method populates the instance with data ga - The object used to request the connection to the remote host by calling one of the methods. + The object used to request the connection to the remote host by calling one of the methods. Cancels an asynchronous request for a remote host connection. instance with data ga ]]> - The parameter cannot be null and the cannot be null. + The parameter cannot be null and the cannot be null. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -3367,7 +3381,8 @@ This method populates the instance with data ga > [!NOTE] > To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time out period. Use this along with the socket option to call the method. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example closes a . @@ -3435,7 +3450,8 @@ This method populates the instance with data ga > [!NOTE] > To set the socket option to `false`, create a , set the enabled property to `true`, and set the property to the desired time-out period. Use this along with the socket option to call the method. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates how to close a . @@ -3518,8 +3534,8 @@ This method populates the instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. - - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3531,9 +3547,9 @@ This method populates the instance with data ga is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The has been placed in a listening state by calling . + The has been placed in a listening state by calling . @@ -3585,8 +3601,8 @@ This method populates the instance with data ga - The IP address of the remote host. - The port number of the remote host. + The IP address of the remote host. + The port number of the remote host. Establishes a connection to a remote host. The host is specified by an IP address and a port number. instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3613,12 +3632,12 @@ This method populates the instance with data ga is . - The port number is not valid. + The port number is not valid. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. This method is valid for sockets in the or families. - The length of is zero. - The has been placed in a listening state by calling . + The length of is zero. + The has been placed in a listening state by calling . @@ -3662,8 +3681,8 @@ This method populates the instance with data ga - The IP addresses of the remote host. - The port number of the remote host. + The IP addresses of the remote host. + The port number of the remote host. Establishes a connection to a remote host. The host is specified by an array of IP addresses and a port number. instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3690,12 +3712,12 @@ This method populates the instance with data ga is . - The port number is not valid. + The port number is not valid. An error occurred when attempting to access the socket. - The has been closed. - The socket is not in the or families. - The length of is zero. - The has been placed in a listening state by calling . + The has been closed. + The socket is not in the or families. + The length of is zero. + The has been placed in a listening state by calling . @@ -3739,8 +3761,8 @@ This method populates the instance with data ga - The name of the remote host. - The port number of the remote host. + The name of the remote host. + The port number of the remote host. Establishes a connection to a remote host. The host is specified by a host name and a port number. instance with data ga > [!NOTE] > If the socket has been previously disconnected, then you cannot use this method to restore the connection. Use one of the asynchronous methods to reconnect. This is a limitation of the underlying provider. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example connects to a remote endpoint and then verifies the connection. @@ -3769,11 +3794,11 @@ This method populates the instance with data ga is . - The port number is not valid. + The port number is not valid. An error occurred when attempting to access the socket. - The has been closed. - The socket is not in the or families. - The has been placed in a listening state by calling . + The has been closed. + The socket is not in the or families. + The has been placed in a listening state by calling . @@ -3813,15 +3838,15 @@ This method populates the instance with data ga - The endpoint to connect to. + The endpoint to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. - The is listening. + The parameter cannot be null. + The is listening. An error occurred when attempting to access the socket. - The local endpoint and the parameter are not the same address family. - The has been closed. + The local endpoint and the parameter are not the same address family. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -3865,7 +3890,7 @@ This method populates the instance with data ga - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins an asynchronous request for a connection to a remote host. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -3889,9 +3914,8 @@ This method populates the instance with data ga The following properties and events on the object are required: -- - -- +- +- Optionally, a buffer may be provided that will atomically be sent on the socket after the method succeeds. In this case, the property needs to be set to the buffer containing the data to send and the property needs to be set to the number of bytes of data to send from the buffer. Once a connection is established, this buffer of data is sent. @@ -3907,11 +3931,11 @@ This method populates the instance with data ga ]]> An argument is not valid. This exception occurs if multiple buffers are specified, the property is not null. - The parameter cannot be null and the cannot be null. - The is listening or a socket operation was already in progress using the object specified in the parameter. + The parameter cannot be null and the cannot be null. + The is listening or a socket operation was already in progress using the object specified in the parameter. An error occurred when attempting to access the socket. - The local endpoint and the are not the same address family. - The has been closed. + The local endpoint and the are not the same address family. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -3949,18 +3973,18 @@ This method populates the instance with data ga - The endpoint to connect to. + The endpoint to connect to. A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. - The is listening. + The parameter cannot be null. + The is listening. An error occurred when attempting to access the socket. - The local endpoint and the parameter are not the same address family. - The has been closed. + The local endpoint and the parameter are not the same address family. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3991,22 +4015,22 @@ This method populates the instance with data ga - The IPAddress of the remote host to connect to. - The port on the remote host to connect to. + The IPAddress of the remote host to connect to. + The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. + The parameter cannot be null. is less than . -or- is greater than . - The is listening. - The socket is not in the or families. + The is listening. + The socket is not in the or families. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -4039,22 +4063,22 @@ This method populates the instance with data ga A list of IPAddresses for the remote host that will be used to attempt to connect to the remote host. - The port on the remote host to connect to. + The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. - The parameter cannot be empty array. + The parameter cannot be null. + The parameter cannot be empty array. is less than . -or- is greater than . - The is listening. - The socket is not in the or families. + The is listening. + The socket is not in the or families. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -4086,22 +4110,22 @@ This method populates the instance with data ga - The hostname of the remote host to connect to. - The port on the remote host to connect to. + The hostname of the remote host to connect to. + The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. + The parameter cannot be null. is less than . -or- is greater than . - The is listening. - The socket is not in the or families. + The is listening. + The socket is not in the or families. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -4134,24 +4158,24 @@ This method populates the instance with data ga - The IPAddress of the remote host to connect to. - The port on the remote host to connect to. + The IPAddress of the remote host to connect to. + The port on the remote host to connect to. A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. + The parameter cannot be null. is less than . -or- is greater than . - The is listening. + The is listening. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4184,25 +4208,25 @@ This method populates the instance with data ga A list of IPAddresses for the remote host that will be used to attempt to connect to the remote host. - The port on the remote host to connect to. + The port on the remote host to connect to. A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. - The parameter cannot be empty array. + The parameter cannot be null. + The parameter cannot be empty array. is less than . -or- is greater than . - The is listening. - The socket is not in the or families. + The is listening. + The socket is not in the or families. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4248,7 +4272,7 @@ This method populates the instance with data ga One of the values. One of the values. - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins an asynchronous request for a connection to a remote host. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -4272,9 +4296,9 @@ This method populates the instance with data ga The following properties and events on the object are required: -- +- -- +- Optionally, a buffer may be provided that will atomically be sent on the socket after the method succeeds. In this case, the property needs to be set to the buffer containing the data to send and the property needs to be set to the number of bytes of data to send from the buffer. Once a connection is established, this buffer of data is sent. @@ -4290,11 +4314,11 @@ This method populates the instance with data ga ]]> An argument is not valid. This exception occurs if multiple buffers are specified, the property is not null. - The parameter cannot be null and the cannot be null. - The is listening or a socket operation was already in progress using the object specified in the parameter. + The parameter cannot be null and the cannot be null. + The is listening or a socket operation was already in progress using the object specified in the parameter. An error occurred when attempting to access the socket. - The local endpoint and the are not the same address family. - The has been closed. + The local endpoint and the are not the same address family. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. @@ -4327,25 +4351,25 @@ This method populates the instance with data ga - The hostname of the remote host to connect to. - The port on the remote host to connect to. + The hostname of the remote host to connect to. + The port on the remote host to connect to. A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter cannot be null. + The parameter cannot be null. is less than . -or- is greater than . - The is listening. - The socket is not in the or families. + The is listening. + The socket is not in the or families. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller higher in the call stack does not have permission for the requested operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4506,7 +4530,8 @@ This method populates the instance with data ga > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example creates a socket for synchronous communication and sends some data to a remote host. It then calls , to stop the send and receive activity, and , to close the socket connection. @@ -4515,7 +4540,7 @@ This method populates the instance with data ga ]]> - The object has been closed. + The object has been closed. An error occurred when attempting to access the socket. @@ -4558,7 +4583,7 @@ This method populates the instance with data ga - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins an asynchronous request to disconnect from a remote endpoint. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -4572,9 +4597,9 @@ This method populates the instance with data ga ]]> - The parameter cannot be null. + The parameter cannot be null. A socket operation was already in progress using the object specified in the parameter. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -4613,9 +4638,9 @@ This method populates the instance with data ga Disconnects a connected socket from the remote host. An asynchronous task that completes when the socket is disconnected. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The object has been closed. + The object has been closed. An error occurred when attempting to access the socket. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4736,6 +4761,9 @@ This method populates the instance with data ga When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -4801,9 +4829,9 @@ This method populates the instance with data ga ]]> - The socket is not in the family. + The socket is not in the family. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -4846,7 +4874,7 @@ This method populates the instance with data ga if the is a dual-mode socket; otherwise, . The default is if the socket was created by calling the constructor and the operating system supports IPv6; otherwise, the default is . To be added. - The socket is not in the address family. + The socket is not in the address family. @@ -4894,9 +4922,9 @@ This method populates the instance with data ga - The ID of the target process where a duplicate of the socket reference is created. + The ID of the target process where a duplicate of the socket reference is created. Duplicates the socket reference for the target process, and closes the socket for this process. - The socket reference to be passed to the target process. + The socket reference to be passed to the target process. ]]> This option is valid for a datagram socket only. - The has been closed. + The has been closed. @@ -5188,7 +5216,7 @@ Duplication of the socket reference failed. An array of type that contains the bytes transferred. - The number of bytes transferred. + The number of bytes transferred. An object that stores state information for this asynchronous operation as well as any user defined data. Asynchronously accepts an incoming connection attempt and creates a new object to handle remote host communication. This method returns a buffer that contains the initial data and the number of bytes transferred. A object to handle communication with the remote host. @@ -5368,7 +5396,7 @@ Duplication of the socket reference failed. -or- .NET 7+ only: The has been closed. - The disconnect request has timed out. + The disconnect request has timed out. @@ -5423,7 +5451,7 @@ Duplication of the socket reference failed. An that stores state information and any user defined data for this asynchronous operation. Ends a pending asynchronous read. - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5507,7 +5535,7 @@ Duplication of the socket reference failed. An that stores state information and any user defined data for this asynchronous operation. A object that stores the socket error. Ends a pending asynchronous read. - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). > If you receive a , use the property to obtain the specific error code. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. +> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] -> All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. +> This member outputs trace information when you enable network tracing in your application. ]]> @@ -5590,9 +5618,9 @@ Duplication of the socket reference failed. An that stores state information and any user defined data for this asynchronous operation. - The source . + The source . Ends a pending asynchronous read from a specific endpoint. - If successful, the number of bytes received. If unsuccessful, returns 0. + If successful, the number of bytes received. If unsuccessful, returns 0. An that stores state information and any user defined data for this asynchronous operation. A bitwise combination of the values for the received packet. - The source . - The and interface of the received packet. + The source . + The and interface of the received packet. Ends a pending asynchronous read from a specific endpoint. This method also reveals more information about the packet than . - If successful, the number of bytes received. If unsuccessful, returns 0. + If successful, the number of bytes received. If unsuccessful, returns 0. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - ]]> @@ -5761,7 +5786,7 @@ Duplication of the socket reference failed. An that stores state information for this asynchronous operation. Ends a pending asynchronous send. - If successful, the number of bytes sent to the ; otherwise, an invalid error. + If successful, the number of bytes sent to the ; otherwise, an invalid error. > [!NOTE] > If you receive a , use the property to obtain the specific error code. -> [!NOTE] -> This member outputs trace information when you enable network tracing in your application. - > [!NOTE] > All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. > [!NOTE] > The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -5850,7 +5875,7 @@ Duplication of the socket reference failed. An that stores state information for this asynchronous operation. A object that stores the socket error. Ends a pending asynchronous send. - If successful, the number of bytes sent to the ; otherwise, an invalid error. + If successful, the number of bytes sent to the ; otherwise, an invalid error. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> .NET 8+ only: The socket is not connected to a remote host. @@ -6009,7 +6037,7 @@ Duplication of the socket reference failed. An that stores state information and any user defined data for this asynchronous operation. Ends a pending asynchronous send to a specific location. - If successful, the number of bytes sent; otherwise, an invalid error. + If successful, the number of bytes sent; otherwise, an invalid error. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -6097,7 +6128,7 @@ Duplication of the socket reference failed. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. has been called for this . @@ -6182,11 +6213,11 @@ Duplication of the socket reference failed. - The platform-defined option level. - The platform-defined option name. - The span into which the retrieved option value should be stored. + The platform-defined option level. + The platform-defined option name. + The span into which the retrieved option value should be stored. Gets a socket option value using platform-specific level and name identifiers. - The number of bytes written into for a successfully retrieved value. + The number of bytes written into for a successfully retrieved value. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -6268,7 +6299,8 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example retrieves the and time-out values and displays them to the console. @@ -6283,7 +6315,7 @@ In general, the `GetSocketOption` method should be used whenever getting a was set to the unsupported value . - The has been closed. + The has been closed. @@ -6344,7 +6376,8 @@ In general, the `GetSocketOption` method should be used whenever getting a option, will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. Use this overload for any sockets that are represented by Boolean values or integers. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example retrieves the and time-out values and displays them to the console. @@ -6359,7 +6392,7 @@ In general, the `GetSocketOption` method should be used whenever getting a . - The has been closed. + The has been closed. @@ -6410,7 +6443,7 @@ In general, the `GetSocketOption` method should be used whenever getting a One of the values. One of the values. - The length, in bytes, of the expected return value. + The length, in bytes, of the expected return value. Returns the value of the specified option in an array. An array of type that contains the value of the socket option. @@ -6422,7 +6455,8 @@ In general, the `GetSocketOption` method should be used whenever getting a [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example retrieves the and time-out values and displays them to the console. @@ -6437,7 +6471,7 @@ In general, the `GetSocketOption` method should be used whenever getting a . - The has been closed. + The has been closed. @@ -6543,7 +6577,7 @@ In general, the `GetSocketOption` method should be used whenever getting a A array that contains the input data required by the operation. A array that contains the output data returned by the operation. Sets low-level operating modes for the using numerical control codes. - The number of bytes in the parameter. + The number of bytes in the parameter. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example compares the results of FIONREAD and the Available property. @@ -6563,7 +6598,7 @@ In general, the `GetSocketOption` method should be used whenever getting a An error occurred when attempting to access the socket. - The has been closed. + The has been closed. An attempt was made to change the blocking mode without using the property. A caller in the call stack does not have the required permissions. @@ -6615,7 +6650,7 @@ In general, the `GetSocketOption` method should be used whenever getting a An array of type that contains the input data required by the operation. An array of type that contains the output data returned by the operation. Sets low-level operating modes for the using the enumeration to specify control codes. - The number of bytes in the parameter. + The number of bytes in the parameter. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example compares the results of calling with and the property. @@ -6635,7 +6671,7 @@ In general, the `GetSocketOption` method should be used whenever getting a An error occurred when attempting to access the socket. - The has been closed. + The has been closed. An attempt was made to change the blocking mode without using the property. @@ -6776,7 +6812,7 @@ In general, the `GetSocketOption` method should be used whenever getting a An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -6858,7 +6894,7 @@ The maximum length of the pending connections queue is determined automatically. - The maximum length of the pending connections queue. + The maximum length of the pending connections queue. Places a in a listening state. You must call the method before calling , or will throw a . > [!NOTE] -> The backlog parameter is limited to different values depending on the Operating System. You may specify a higher value, but the backlog will be limited based on the Operating System. - +> This member outputs trace information when you enable network tracing in your application. +> [!NOTE] +> The backlog parameter is limited to different values depending on the Operating System. You may specify a higher value, but the backlog will be limited based on the Operating System. ## Examples The following code example uses to listen for incoming connections. @@ -6885,7 +6922,7 @@ The maximum length of the pending connections queue is determined automatically. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -6937,7 +6974,7 @@ The maximum length of the pending connections queue is determined automatically. Gets the local endpoint. - The that the is using for communications. + The that the is using for communications. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example retrieves and displays the local and remote endpoints. @@ -6960,7 +6998,7 @@ The maximum length of the pending connections queue is determined automatically. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -7022,8 +7060,8 @@ The maximum length of the pending connections queue is determined automatically. ]]> An error occurred when attempting to access the socket. - The has been closed. - The is not in the or families. + The has been closed. + The is not in the or families. @@ -7086,7 +7124,7 @@ The maximum length of the pending connections queue is determined automatically. ]]> An error occurred when attempting to access the . - The has been closed. + The has been closed. @@ -7263,10 +7301,10 @@ The maximum length of the pending connections queue is determined automatically. - The time to wait for a response, in microseconds. + The time to wait for a response, in microseconds. One of the values. Determines the status of the . - The status of the based on the polling mode value passed in the parameter. + The status of the based on the polling mode value passed in the parameter.
  • For , it returns if has been called and a connection is pending, if data is available for reading, or if the connection has been closed, reset, or terminated.
  • For , it returns if processing a and the connection has succeeded or if data can be sent.
  • For , it returns if processing a that does not block and the connection has failed, or if is not set and out-of-band data is available.
  • Otherwise, it returns .
 [!NOTE] > This method cannot detect certain kinds of connection problems, such as a broken network cable, or that the remote host was shut down ungracefully. You must attempt to send or receive data to detect these kinds of errors. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example creates a socket, connects to a server, and uses to check the status of the socket. @@ -7288,9 +7329,9 @@ The maximum length of the pending connections queue is determined automatically. ]]> - The parameter is not one of the values. + The parameter is not one of the values. An error occurred when attempting to access the socket. See remarks below. - The has been closed. + The has been closed. @@ -7322,16 +7363,16 @@ The maximum length of the pending connections queue is determined automatically. - The time to wait for a response. + The time to wait for a response. One of the values. Determines the status of the . - The status of the based on the polling mode value passed in the parameter. Returns if any of the following conditions occur before the expires, otherwise, . + The status of the based on the polling mode value passed in the parameter. Returns if any of the following conditions occur before the expires, otherwise, .
  • For , it returns if has been called and a connection is pending, if data is available for reading, or if the connection has been closed, reset, or terminated.
  • For , it returns if processing a and the connection has succeeded or if data can be sent.
  • For , it returns if processing a that does not block and the connection has failed, or if is not set and out-of-band data is available.
  • Otherwise, it returns .
 To be added. is less than -1 milliseconds or greater than milliseconds. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -7445,7 +7486,7 @@ The maximum length of the pending connections queue is determined automatically. An array of type that is the storage location for the received data. Receives data from a bound into a receive buffer. - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example receives data on a connected . @@ -7478,7 +7520,7 @@ The maximum length of the pending connections queue is determined automatically. is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -7536,7 +7578,7 @@ The maximum length of the pending connections queue is determined automatically. A list of s of type that contains the received data. Receives data from a bound into the list of receive buffers. - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> - The parameter is . + The parameter is . An error occurred while attempting to access the socket. - The has been closed. + The has been closed. @@ -7597,7 +7642,7 @@ The maximum length of the pending connections queue is determined automatically. A span of bytes that is the storage location for the received data. Receives data from a bound into a receive buffer. - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -7674,7 +7723,7 @@ If you're using a connectionless , An array of type that is the storage location for the received data. A bitwise combination of the values. Receives data from a bound into a receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example specifies a data buffer, and for receiving data on a connected . @@ -7707,7 +7757,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -7767,7 +7817,7 @@ If you're using a connectionless , A list of s of type that contains the received data. A bitwise combination of the values. Receives data from a bound into the list of receive buffers, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates how to receive data on a connected . @@ -7804,7 +7855,7 @@ If you're using a connectionless , .Count is zero. An error occurred while attempting to access the socket. - The has been closed. + The has been closed. @@ -7847,7 +7898,7 @@ If you're using a connectionless , A span of bytes that is the storage location for the received data. A bitwise combination of the enumeration values that specifies send and receive behaviors. Receives data from a bound into a receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -7923,10 +7977,10 @@ If you're using a connectionless , An array of type that is the storage location for the received data. - The number of bytes to receive. + The number of bytes to receive. A bitwise combination of the values. Receives the specified number of bytes of data from a bound into a receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following receives the data found into `buffer`, and specifies for . @@ -7961,7 +8016,7 @@ If you're using a connectionless , exceeds the size of . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -8023,7 +8078,7 @@ If you're using a connectionless , A bitwise combination of the values. A object that stores the socket error. Receives data from a bound into the list of receive buffers, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -8053,7 +8111,7 @@ If you're using a connectionless , .Count is zero. An error occurred while attempting to access the socket. - The has been closed. + The has been closed. @@ -8098,7 +8156,7 @@ If you're using a connectionless , A bitwise combination of the enumeration values that specifies send and receive behaviors. When this method returns, contains one of the enumeration values that defines error codes for the socket. Receives data from a bound into a receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -8175,11 +8236,11 @@ If you're using a connectionless , An array of type that is the storage location for received data. - The location in to store the received data. - The number of bytes to receive. + The location in to store the received data. + The number of bytes to receive. A bitwise combination of the values. Receives the specified number of bytes from a bound into the specified offset position of the receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example specifies a data buffer, an offset, a size, and a socket flag before receiving data on a connected . @@ -8233,7 +8295,7 @@ If you're using a connectionless , . - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -8287,12 +8349,12 @@ If you're using a connectionless , An array of type that is the storage location for the received data. - The position in the parameter to store the received data. - The number of bytes to receive. + The position in the parameter to store the received data. + The number of bytes to receive. A bitwise combination of the values. A object that stores the socket error. Receives data from a bound into a receive buffer, using the specified . - The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , , will read the first queued datagram from the destination address you specify in the method. If the datagram you receive is larger than the size of the `buffer` parameter, `buffer` gets filled with the first part of the message, the excess data is lost and a is thrown. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -8325,7 +8390,7 @@ If you're using a connectionless , is greater than the length of minus the value of the parameter. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -8366,11 +8431,11 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. Receives data from a connected socket. A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). To be added. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -8411,8 +8476,8 @@ If you're using a connectionless , Receives data from a connected socket. A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into the buffers between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter was null. - The has been closed. + The parameter was null. + The has been closed. An error occurred when attempting to access the socket. @@ -8456,7 +8521,7 @@ If you're using a connectionless , - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins an asynchronous request to receive data from a connected object. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -8474,13 +8539,13 @@ If you're using a connectionless , object are required to successfully call this method: -- or +- or -- if is set +- if is set -- if is set +- if is set -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -8494,7 +8559,7 @@ If you're using a connectionless , An argument was invalid. The or properties on the parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time. A socket operation was already in progress using the object specified in the parameter. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -8539,13 +8604,13 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. Receives data from a connected socket. A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). To be added. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -8590,8 +8655,8 @@ If you're using a connectionless , A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The parameter was null. - The has been closed. + The parameter was null. + The has been closed. An error occurred when attempting to access the socket. @@ -8621,14 +8686,14 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A cancellation token that can be used to cancel the asynchronous operation. Receives data from a connected socket. A that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). To be added. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -8659,15 +8724,15 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. A cancellation token that can be used to cancel the asynchronous operation. Receives data from a connected socket. A that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). To be added. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -8725,8 +8790,8 @@ If you're using a connectionless , An error occurred when attempting to access the socket. - The has been closed. - The value specified for a set operation is less than 0. + The has been closed. + The value specified for a set operation is less than 0. @@ -8784,7 +8849,7 @@ If you're using a connectionless , An array of type that is the storage location for received data. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives a datagram into the data buffer and stores the endpoint. - The number of bytes received. + The number of bytes received. , [!NOTE] > The of the used in needs to match the of the used in . - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example receives a connectionless datagram from a remote host. @@ -8827,7 +8893,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -8874,12 +8940,12 @@ If you're using a connectionless , A span of bytes that is the storage location for received data. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives a datagram into the data buffer and stores the endpoint. - The number of bytes received. + The number of bytes received. To be added. remoteEP is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -8929,7 +8995,7 @@ If you're using a connectionless , A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives a datagram into the data buffer, using the specified , and stores the endpoint. - The number of bytes received. + The number of bytes received. , [!NOTE] > The of the used in needs to match the of the used in . - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example receives a connectionless datagram from a remote host. are passed to the method. @@ -8972,7 +9039,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -9022,12 +9089,12 @@ If you're using a connectionless , A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives a datagram into the data buffer, using the specified , and stores the endpoint. - The number of bytes received. + The number of bytes received. To be added. remoteEP is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -9068,12 +9135,12 @@ If you're using a connectionless , A bitwise combination of the values. A instance that gets updated with the value of the remote peer when this method returns. Receives a datagram into the data buffer, using the specified , and stores the endpoint. - The number of bytes received. + The number of bytes received. To be added. is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -9121,11 +9188,11 @@ If you're using a connectionless , An array of type that is the storage location for received data. - The number of bytes to receive. + The number of bytes to receive. A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives the specified number of bytes into the data buffer, using the specified , and stores the endpoint. - The number of bytes received. + The number of bytes received. , [!NOTE] > The of the used in needs to match the of the used in . - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example receives a connectionless datagram from a remote host. The buffer size, and are passed to the method. @@ -9180,7 +9248,7 @@ If you're using a connectionless , . - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -9236,12 +9304,12 @@ If you're using a connectionless , An array of type that is the storage location for received data. - The position in the parameter to store the received data. - The number of bytes to receive. + The position in the parameter to store the received data. + The number of bytes to receive. A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. Receives the specified number of bytes of data into the specified location of the data buffer, using the specified , and stores the endpoint. - The number of bytes received. + The number of bytes received. , [!NOTE] > The of the used in needs to match the of the used in . - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example receives a connectionless datagram from a remote host. The offset, buffer size, and are passed to the method. @@ -9302,7 +9371,7 @@ If you're using a connectionless , - The has been closed. + The has been closed. @@ -9351,7 +9420,7 @@ If you're using a connectionless , - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins to asynchronously receive data from a specified network device. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -9369,15 +9438,15 @@ If you're using a connectionless , object are required to successfully call this method: -- +- -- +- -- +- -- +- -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -9387,9 +9456,9 @@ If you're using a connectionless , - The cannot be null. + The cannot be null. A socket operation was already in progress using the object specified in the parameter. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -9434,7 +9503,7 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. An endpoint of the same type as the endpoint of the remote host. Receives data and returns the endpoint of the sending host. An asynchronous task that completes with a containing the number of bytes received and the endpoint of the sending host. @@ -9442,7 +9511,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -9482,7 +9551,7 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. An endpoint of the same type as the endpoint of the remote host. Receives data and returns the endpoint of the sending host. @@ -9491,7 +9560,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -9529,7 +9598,7 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. An endpoint of the same type as the endpoint of the remote host. A cancellation token that can be used to signal the asynchronous operation should be canceled. Receives data and returns the endpoint of the sending host. @@ -9538,9 +9607,9 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -9579,7 +9648,7 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. An endpoint of the same type as the endpoint of the remote host. A cancellation token that can be used to signal the asynchronous operation should be canceled. @@ -9589,9 +9658,9 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -9628,7 +9697,7 @@ If you're using a connectionless , - The buffer for the received data. + The buffer for the received data. A bitwise combination of the values that will be used when receiving the data. A instance that gets updated with the value of the remote peer when this method returns. A cancellation token that can be used to signal the asynchronous operation should be canceled. @@ -9638,8 +9707,8 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -9684,12 +9753,12 @@ If you're using a connectionless , A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. An holding address and interface information. Receives the specified number of bytes of data into the specified location of the data buffer, using the specified , and stores the endpoint and packet information. - The number of bytes received. + The number of bytes received. To be added. - The object has been closed. - The remoteEP is . - The of the used in needs to match the of the used in SendTo. - The object is not in blocking mode and cannot accept this synchronous call. + The object has been closed. + The remoteEP is . + The of the used in needs to match the of the used in SendTo. + The object is not in blocking mode and cannot accept this synchronous call. You must call the Bind method before performing this operation. @@ -9739,13 +9808,13 @@ You must call the Bind method before performing this operation. An array of type that is the storage location for received data. - The position in the parameter to store the received data. - The number of bytes to receive. + The position in the parameter to store the received data. + The number of bytes to receive. A bitwise combination of the values. A reference to an of the same type as the endpoint of the remote host to be updated on successful receive. An holding address and interface information. Receives the specified number of bytes of data into the specified location of the data buffer, using the specified , and stores the endpoint and packet information. - The number of bytes received. + The number of bytes received. > [!NOTE] > The of the used in needs to match the of the used in . +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ]]> @@ -9801,7 +9873,7 @@ You must call the Bind method before performing this operation. -or- An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -9849,7 +9921,7 @@ You must call the Bind method before performing this operation. - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Begins to asynchronously receive the specified number of bytes of data into the specified location in the data buffer, using the specified , and stores the endpoint and packet information. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -9865,15 +9937,15 @@ You must call the Bind method before performing this operation. The following properties and events on the object are required to successfully call this method: -- +- -- +- -- +- -- +- -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -9887,8 +9959,8 @@ You must call the Bind method before performing this operation. ]]> - The cannot be null. - The has been closed. + The cannot be null. + The has been closed. An error occurred when attempting to access the socket. @@ -9933,12 +10005,12 @@ You must call the Bind method before performing this operation. - The buffer for the received data. + The buffer for the received data. An endpoint of the same type as the endpoint of the remote host. Receives data and returns additional information about the sender of the message. An asynchronous task that completes with a containing the number of bytes received and additional information about the sending host. To be added. - The object has been closed. + The object has been closed. is . You must call the Bind method before performing this operation. @@ -9980,13 +10052,13 @@ You must call the Bind method before performing this operation. - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. An endpoint of the same type as the endpoint of the remote host. Receives data and returns additional information about the sender of the message. An asynchronous task that completes with a containing the number of bytes received and additional information about the sending host. To be added. - The object has been closed. + The object has been closed. is . You must call the Bind method before performing this operation. @@ -10026,17 +10098,17 @@ You must call the Bind method before performing this operation. - The buffer for the received data. + The buffer for the received data. An endpoint of the same type as the endpoint of the remote host. A cancellation token that can be used to signal the asynchronous operation should be canceled. Receives data and returns additional information about the sender of the message. An asynchronous task that completes with a containing the number of bytes received and additional information about the sending host. To be added. - The object has been closed. + The object has been closed. is . You must call the Bind method before performing this operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10075,18 +10147,18 @@ You must call the Bind method before performing this operation. - The buffer for the received data. + The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. An endpoint of the same type as the endpoint of the remote host. A cancellation token that can be used to signal the asynchronous operation should be canceled. Receives data and returns additional information about the sender of the message. An asynchronous task that completes with a containing the number of bytes received and additional information about the sending host. To be added. - The object has been closed. + The object has been closed. is . You must call the Bind method before performing this operation. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10127,14 +10199,15 @@ You must call the Bind method before performing this operation. Gets or sets a value that specifies the amount of time after which a synchronous call will time out. - The time-out value, in milliseconds. The default value is 0, which indicates an infinite time-out period. Specifying -1 also indicates an infinite time-out period. + The time-out value, in milliseconds. The default value is 0, which indicates an infinite time-out period. Specifying -1 also indicates an infinite time-out period. calls only. If the time-out period is exceeded, the method will throw a . - +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples The following code example demonstrates the use of the property. @@ -10144,8 +10217,8 @@ You must call the Bind method before performing this operation. ]]> An error occurred when attempting to access the socket. - The has been closed. - The value specified for a set operation is less than -1. + The has been closed. + The value specified for a set operation is less than -1. @@ -10194,7 +10267,7 @@ You must call the Bind method before performing this operation. Gets the remote endpoint. - The with which the is communicating. + The with which the is communicating. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10307,7 +10380,7 @@ You must call the Bind method before performing this operation. An of instances to check for readability. An of instances to check for writability. An of instances to check for errors. - The time-out value, in microseconds. A -1 value indicates an infinite time-out. + The time-out value, in microseconds. A -1 value indicates an infinite time-out. Determines the status of one or more sockets. ]]> - The , , and parameters are all or empty. At least one of , , or must contain at least one . + The , , and parameters are all or empty. At least one of , , or must contain at least one . An error occurred when attempting to access the socket. .NET 5 and later: One or more sockets are disposed. - The , , or parameter contains too many sockets. + The , , or parameter contains too many sockets. @@ -10384,12 +10457,12 @@ You must call the Bind method before performing this operation. An of instances to check for readability. An of instances to check for writability. An of instances to check for errors. - The timeout value. A value equal to -1 microseconds indicates an infinite timeout. + The timeout value. A value equal to -1 microseconds indicates an infinite timeout. Determines the status of one or more sockets. To be added. - The , , and parameters are all or empty. At least one of , , or must contain at least one . - The , , or parameter contains too many sockets. - The was less than -1 microseconds or greater than microseconds + The , , and parameters are all or empty. At least one of , , or must contain at least one . + The , , or parameter contains too many sockets. + The was less than -1 microseconds or greater than microseconds An error occurred when attempting to access the socket. One or more sockets was disposed. @@ -10447,7 +10520,7 @@ You must call the Bind method before performing this operation. An array of type that contains the data to be sent. Sends data to a connected . - The number of bytes sent to the . + The number of bytes sent to the . is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10538,7 +10611,7 @@ You must call the Bind method before performing this operation. A list of s of type that contains the data to be sent. Sends the set of buffers in the list to a connected . - The number of bytes sent to the . + The number of bytes sent to the . is empty. An error occurred when attempting to access the socket. See remarks section below. - The has been closed. + The has been closed. @@ -10606,7 +10679,7 @@ You must call the Bind method before performing this operation. A span of bytes that contains the data to be sent. Sends data to a connected . - The number of bytes sent to the . + The number of bytes sent to the . will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There's also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] ->If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. > [!IMPORTANT] ->The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10683,7 +10759,7 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. A bitwise combination of the values. Sends data to a connected using the specified . - The number of bytes sent to the . + The number of bytes sent to the . is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10776,7 +10852,7 @@ If you're using a connection-oriented protocol, A list of s of type that contains the data to be sent. A bitwise combination of the values. Sends the set of buffers in the list to a connected , using the specified . - The number of bytes sent to the . + The number of bytes sent to the . is empty. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10844,16 +10920,10 @@ If you're using a connection-oriented protocol, A span of bytes that contains the data to be sent. A bitwise combination of the enumeration values that specifies send and receive behaviors. Sends data to a connected using the specified . - The number of bytes sent to the . - - - + The number of bytes sent to the . + To be added. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -10904,10 +10974,10 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The number of bytes to send. + The number of bytes to send. A bitwise combination of the values. Sends the specified number of bytes of data to a connected , using the specified . - The number of bytes sent to the . + The number of bytes sent to the . will > You must ensure that the size does not exceed the maximum packet size of the underlying service provider. If it does, the datagram won't be sent and will throw a . If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!IMPORTANT] ->The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ## Examples @@ -10947,7 +11020,7 @@ The following code example sends the data found in buffer, and specifies - The has been closed. + The has been closed. @@ -11007,7 +11080,7 @@ The following code example sends the data found in buffer, and specifies A bitwise combination of the values. A object that stores the socket error. Sends the set of buffers in the list to a connected , using the specified . - The number of bytes sent to the . + The number of bytes sent to the . is empty. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11077,7 +11150,7 @@ The following code example sends the data found in buffer, and specifies A bitwise combination of the enumeration values that specifies send and receive behaviors. When this method returns, contains one of the enumeration values that defines error codes for the socket. Sends data to a connected using the specified . - The number of bytes sent to the . + The number of bytes sent to the . will block until all of the bytes in the buffer are sent, unless a time-out was set by using . If the time-out value was exceeded, the call will throw a . In nonblocking mode, may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the bytes in the buffer. There's also no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the method means that the underlying system has had room to buffer your data for a network send. > [!NOTE] ->If you receive a , use the property to obtain the specific error code. After you've obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> If you receive a , use the property to obtain the specific error code. After you've obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!IMPORTANT] ->The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. +> The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. ]]> An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11153,11 +11229,11 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The position in the data buffer at which to begin sending data. - The number of bytes to send. + The position in the data buffer at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. Sends the specified number of bytes of data to a connected , starting at the specified offset, and using the specified . - The number of bytes sent to the . + The number of bytes sent to the . . - The has been closed. + The has been closed. @@ -11265,12 +11341,12 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The position in the data buffer at which to begin sending data. - The number of bytes to send. + The position in the data buffer at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. A object that stores the socket error. Sends the specified number of bytes of data to a connected , starting at the specified offset, and using the specified . - The number of bytes sent to the . + The number of bytes sent to the . . - The has been closed. + The has been closed. @@ -11365,12 +11441,12 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. To be added. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11413,7 +11489,7 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11456,7 +11532,7 @@ If you're using a connection-oriented protocol, - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Sends data asynchronously to a connected object. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -11472,13 +11548,13 @@ If you're using a connection-oriented protocol, object are required to successfully call this method: -- or +- or -- if is set +- if is set -- if is set +- if is set -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -11492,10 +11568,10 @@ If you're using a connection-oriented protocol, - The or properties on the parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time. + The or properties on the parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time. A socket operation was already in progress using the object specified in the parameter. - The has been closed. - The is not yet connected or was not obtained via an , ,or , method. + The has been closed. + The is not yet connected or was not obtained via an , ,or , method. @@ -11539,13 +11615,13 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A bitwise combination of SocketFlags values that will be used when sending the data. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. To be added. An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11591,7 +11667,7 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -11620,12 +11696,12 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A cancellation token that can be used to cancel the asynchronous operation. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. To be added. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -11656,15 +11732,15 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A bitwise combination of SocketFlags values that will be used when sending the data. A cancellation token that can be used to cancel the asynchronous operation. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. To be added. An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -11712,8 +11788,6 @@ If you're using a connection-oriented protocol, property. @@ -11722,8 +11796,8 @@ If you're using a connection-oriented protocol, An error occurred when attempting to access the socket. - The has been closed. - The value specified for a set operation is less than 0. + The has been closed. + The value specified for a set operation is less than 0. @@ -11795,6 +11869,9 @@ If you're using a connection-oriented protocol, [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example creates and connects a socket and then sends a file to the remote host. The file "test.txt" is located in the root directory of the local machine. @@ -11802,10 +11879,10 @@ If you're using a connection-oriented protocol, - The socket is not connected to a remote host. - The object has been closed. - The object is not in blocking mode and cannot accept this synchronous call. - The file was not found. + The socket is not connected to a remote host. + The object has been closed. + The object is not in blocking mode and cannot accept this synchronous call. + The file was not found. An error occurred when attempting to access the socket. @@ -11852,9 +11929,9 @@ If you're using a connection-oriented protocol, - The path and name of the file to be sent. This parameter can be . - The data to be sent before the file is sent. This parameter can be . - The data to be sent after the file is sent. This parameter can be . + The path and name of the file to be sent. This parameter can be . + The data to be sent before the file is sent. This parameter can be . + The data to be sent after the file is sent. This parameter can be . A bitwise combination of the enumeration values that specifies how the file is transferred. Sends the file and buffers of data to a connected object using the specified value. @@ -11876,6 +11953,9 @@ If you're using a connection-oriented protocol, [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example creates and connects a socket. The file "test.txt" is located in the root directory of the local machine. In this example, we create a prebuffer and postbuffer of data and send them to the remote host with the file. The default are used. @@ -11883,14 +11963,14 @@ If you're using a connection-oriented protocol, - The operating system is not Windows NT or later. + The operating system is not Windows NT or later. -or- The socket is not connected to a remote host. - The object has been closed. - The object is not in blocking mode and cannot accept this synchronous call. - The file was not found. + The object has been closed. + The object is not in blocking mode and cannot accept this synchronous call. + The file was not found. An error occurred when attempting to access the socket. @@ -11937,10 +12017,10 @@ If you're using a connection-oriented protocol, One or more of values. Sends the file and buffers of data to a connected object using the specified value. To be added. - The object has been closed. - The object is not connected to a remote host. - The object is not in blocking mode and cannot accept this synchronous call. - The file was not found. + The object has been closed. + The object is not connected to a remote host. + The object is not in blocking mode and cannot accept this synchronous call. + The file was not found. An error occurred when attempting to access the socket. @@ -11976,11 +12056,11 @@ If you're using a connection-oriented protocol, Sends the file to a connected object. A value task that represents the asynchronous send file operation. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - The object has been closed. - The object is not connected to a remote host. - The file was not found. + The object has been closed. + The object is not connected to a remote host. + The file was not found. An error occurred when attempting to access the socket. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12028,11 +12108,11 @@ If you're using a connection-oriented protocol, Sends the file and buffers of data to a connected object using the specified value. A value task that represents the asynchronous send file operation. To be added. - The object has been closed. - The object is not connected to a remote host. - The file was not found. + The object has been closed. + The object is not connected to a remote host. + The file was not found. An error occurred when attempting to access the socket. - The cancellation token was canceled. This exception is stored into the returned task. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12075,7 +12155,7 @@ If you're using a connection-oriented protocol, - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Sends a collection of files or in memory data buffers asynchronously to a connected object. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -12095,9 +12175,9 @@ If you're using a connection-oriented protocol, object are required to successfully call this method: -- +- -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -12113,10 +12193,10 @@ If you're using a connection-oriented protocol, - The file specified in the property was not found. + The file specified in the property was not found. A socket operation was already in progress using the object specified in the parameter. - The is not connected to a remote host. - The has been closed. + The is not connected to a remote host. + The has been closed. A connectionless is being used and the file being sent exceeds the maximum packet size of the underlying transport. @@ -12163,7 +12243,7 @@ If you're using a connection-oriented protocol, Gets or sets a value that specifies the amount of time after which a synchronous call will time out. - The time-out value, in milliseconds. If you set the property with a value between 1 and 499, the value will be changed to 500. The default value is 0, which indicates an infinite time-out period. Specifying -1 also indicates an infinite time-out period. + The time-out value, in milliseconds. If you set the property with a value between 1 and 499, the value will be changed to 500. The default value is 0, which indicates an infinite time-out period. Specifying -1 also indicates an infinite time-out period. An error occurred when attempting to access the socket. - The has been closed. - The value specified for a set operation is less than -1. + The has been closed. + The value specified for a set operation is less than -1. @@ -12235,9 +12315,9 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The that represents the destination for the data. + The that represents the destination for the data. Sends data to the specified endpoint. - The number of bytes sent. + The number of bytes sent. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example sends a connectionless datagram to the specified remote host. @@ -12270,7 +12353,7 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12315,14 +12398,14 @@ If you're using a connection-oriented protocol, A span of bytes that contains the data to be sent. - The that represents the destination for the data. + The that represents the destination for the data. Sends data to the specified endpoint. - The number of bytes sent. + The number of bytes sent. To be added. remoteEP is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12370,9 +12453,9 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. A bitwise combination of the values. - The that represents the destination location for the data. + The that represents the destination location for the data. Sends data to a specific endpoint using the specified . - The number of bytes sent. + The number of bytes sent. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example sends a connectionless datagram to the specified remote host. are passed to the method. @@ -12405,7 +12491,7 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12452,14 +12538,14 @@ If you're using a connection-oriented protocol, A span of bytes that contains the data to be sent. A bitwise combination of the values. - The that represents the destination for the data. + The that represents the destination for the data. Sends data to a specific endpoint using the specified . - The number of bytes sent. + The number of bytes sent. To be added. remoteEP is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12498,14 +12584,14 @@ If you're using a connection-oriented protocol, A span of bytes that contains the data to be sent. A bitwise combination of the values that will be used when sending the data. - The that represents the destination for the data. + The that represents the destination for the data. Sends data to a specific endpoint using the specified . - The number of bytes sent. + The number of bytes sent. To be added. is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12553,11 +12639,11 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The number of bytes to send. + The number of bytes to send. A bitwise combination of the values. - The that represents the destination location for the data. + The that represents the destination location for the data. Sends the specified number of bytes of data to the specified endpoint using the specified . - The number of bytes sent. + The number of bytes sent. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example sends a connectionless datagram to the specified remote host. The size and are passed to the method. @@ -12589,9 +12678,9 @@ If you're using a connection-oriented protocol, is . - The specified exceeds the size of . + The specified exceeds the size of . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12646,12 +12735,12 @@ If you're using a connection-oriented protocol, An array of type that contains the data to be sent. - The position in the data buffer at which to begin sending data. - The number of bytes to send. + The position in the data buffer at which to begin sending data. + The number of bytes to send. A bitwise combination of the values. - The that represents the destination location for the data. + The that represents the destination location for the data. Sends the specified number of bytes of data to the specified endpoint, starting at the specified location in the buffer, and using the specified . - The number of bytes sent. + The number of bytes sent. [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example sends a connectionless datagram to the specified remote host. The offset, size, and are passed to the method. @@ -12703,7 +12795,7 @@ If you're using a connection-oriented protocol, . - The has been closed. + The has been closed. A caller in the call stack does not have the required permissions. @@ -12753,7 +12845,7 @@ If you're using a connection-oriented protocol, - The object to use for this asynchronous socket operation. + The object to use for this asynchronous socket operation. Sends data asynchronously to a specific remote host. if the I/O operation is pending. The event on the parameter will be raised upon completion of the operation. @@ -12769,15 +12861,15 @@ If you're using a connection-oriented protocol, object are required to successfully call this method: -- +- -- +- -- +- -- +- -- +- The caller may set the property to any user state object desired before calling the method, so that the information will be retrievable in the callback method. If the callback needs more information than a single object, a small class can be created to hold the other required state information as members. @@ -12793,10 +12885,10 @@ If you're using a connection-oriented protocol, - The cannot be null. + The cannot be null. A socket operation was already in progress using the object specified in the parameter. - The has been closed. - The protocol specified is connection-oriented, but the is not yet connected. + The has been closed. + The protocol specified is connection-oriented, but the is not yet connected. @@ -12840,15 +12932,15 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. - The remote host to which to send the data. + The buffer for the data to send. + The remote host to which to send the data. Sends data to the specified remote host. An asynchronous task that completes with the number of bytes sent. To be added. is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12887,16 +12979,16 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A bitwise combination of SocketFlags values that will be used when sending the data. - The remote host to which to send the data. + The remote host to which to send the data. Sends data to the specified remote host. An asynchronous task that completes with the number of bytes sent. To be added. is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -12933,8 +13025,8 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. - The remote host to which to send the data. + The buffer for the data to send. + The remote host to which to send the data. A cancellation token that can be used to cancel the asynchronous operation. Sends data to the specified remote host. An asynchronous task that completes with the number of bytes sent. @@ -12942,8 +13034,8 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12982,9 +13074,9 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A bitwise combination of SocketFlags values that will be used when sending the data. - The remote host to which to send the data. + The remote host to which to send the data. A cancellation token that can be used to cancel the asynchronous operation. Sends data to the specified remote host. An asynchronous task that completes with the number of bytes sent. @@ -12992,8 +13084,8 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -13030,9 +13122,9 @@ If you're using a connection-oriented protocol, - The buffer for the data to send. + The buffer for the data to send. A bitwise combination of values that will be used when sending the data. - The that represents the destination for the data. + The that represents the destination for the data. A cancellation token that can be used to cancel the asynchronous operation. Sends data to a specific endpoint using the specified . An asynchronous task that completes with the number of bytes sent. @@ -13040,8 +13132,8 @@ If you're using a connection-oriented protocol, is . An error occurred when attempting to access the socket. - The has been closed. - The cancellation token was canceled. This exception is stored into the returned task. + The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -13088,7 +13180,7 @@ If you're using a connection-oriented protocol, - The IP protection level to set on this socket. + The IP protection level to set on this socket. Sets the IP protection level on a socket. - The argument is set to . - The socket is not in the or address families. + The argument is set to . + The socket is not in the or address families. @@ -13145,9 +13237,9 @@ If you're using a connection-oriented protocol, - The platform-defined option level. - The platform-defined option name. - The value to which the option should be set. + The platform-defined option level. + The platform-defined option name. + The value to which the option should be set. Sets a socket option value using platform-specific level and name identifiers. - The has been closed. + The has been closed. An error occurred when attempting to access the socket. @@ -13218,7 +13310,7 @@ The One of the values. One of the values. - The value of the option, represented as a . + The value of the option, represented as a . Sets the specified option to the specified value. options that can be set using this overload. -- - -- - -- - -- +- +- +- +- +- +- +- -- + options that can be set using this overload. -- +- +- +- -- + options that can be set using this overload. - options that can be set using this overload. +- +- +- -- + options that can be set using this overload. -- +- -- - - options that can be set using this overload. - -- - -- - -- - - options that can be set using this overload. - -- - - For more information on these options, refer to the enumeration. +For more information on these options, refer to the enumeration. > [!NOTE] > If you receive a exception, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example opens a socket and enables the `DontLinger` and the `OutOfBandInline` socket options. @@ -13278,7 +13363,7 @@ The - The object has been closed. + The object has been closed. An error occurred when attempting to access the socket. @@ -13347,7 +13432,7 @@ The An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -13410,71 +13495,53 @@ The options that can be set using this overload. -- - -- - -- - -- - -- - -- - -- - -- - -- - -- +- +- +- +- +- +- +- +- +- +- +- +- -- + options that can be set using this overload. -- +- +- +- +- +- +- +- +- - options that can be set using this overload. + options that can be set using this overload. -- +- +- +- -- + options that can be set using this overload. -- +- +- -- + options that can be set using this overload. -- +- -- - -- - -- - - options that can be set using this overload. - -- - -- - -- - - options that can be set using this overload. - -- - -- - - options that can be set using this overload. - -- - - For more information about these options, refer to the enumeration. +For more information about these options, refer to the enumeration. > [!NOTE] > If you receive a , use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example sets the and time-out values. @@ -13484,7 +13551,7 @@ The An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -13557,7 +13624,7 @@ The is . An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -13616,18 +13683,17 @@ The enumeration values that are valid for the `how` parameter. -|Value|Description| -|-----------|-----------------| -|Send|Disable sending on this .| -|Receive|Disable receiving on this .| -|Both|Disable both sending and receiving on this .| +| Value | Description | +|---------|------------------------------------------------------------------------------| +| Send | Disable sending on this . | +| Receive | Disable receiving on this . | +| Both | Disable both sending and receiving on this . | Setting `how` to specifies that subsequent calls to are not allowed. If you are using a connectionless , specifying will have no effect. - Setting `how` to specifies that subsequent calls to are not allowed. This has no effect on lower protocol layers. If you are using a connection-oriented protocol, the connection is terminated if either of the following conditions exist after a call to : + Setting `how` to specifies that subsequent calls to are not allowed. This has no effect on lower protocol layers. If you are using a connection-oriented protocol, the connection is terminated if either of the following conditions exist after a call to : - Data is in the incoming network buffer waiting to be received. - - More data has arrived. If you are using a connectionless protocol, datagrams are accepted and queued. However, if no buffer space is available for additional incoming datagrams, they will be discarded and no error will be returned to the sender. Using on a connectionless is not recommended. @@ -13637,6 +13703,9 @@ The [!NOTE] > If you receive a when calling the method, use the property to obtain the specific error code. After you have obtained this code, refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. + ## Examples The following code example uses to disable the . @@ -13646,7 +13715,7 @@ The An error occurred when attempting to access the socket. - The has been closed. + The has been closed. @@ -13870,7 +13939,7 @@ The Gets or sets a value that specifies the Time To Live (TTL) value of Internet Protocol (IP) packets sent by the . - The TTL value. + The TTL value. - The TTL value is a negative number. - The socket is not in the or families. + The TTL value is a negative number. + The socket is not in the or families. An error occurred when attempting to access the socket. This error is also returned when an attempt was made to set TTL to a value higher than 255. - The has been closed. + The has been closed. @@ -13944,8 +14013,8 @@ The Gets or sets a value that specifies whether the socket should only use Overlapped I/O mode. Always . - The value of this property is always `false`, and you cannot change its value. - The socket has been bound to a completion port. + The value of this property is always `false`, and you cannot change its value. + The socket has been bound to a completion port. diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index 2188c515de0..95caa9f7e7e 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -147,9 +147,6 @@ ## Remarks This constructor creates a new and allows the underlying service provider to assign the most appropriate local IP address and port number. You must first call the method before sending and receiving data. -> [!NOTE] -> On .NET Framework, this constructor works only with IPv4 address types. - > [!NOTE] > This member outputs trace information when you enable network tracing in your application. @@ -918,7 +915,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -992,7 +989,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1067,7 +1064,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1216,7 +1213,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you've obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive a `NotSupportedException` with the message "This protocol version is not supported" while using IPv6 address, make sure you enabled IPv6 in the constructor by passing . @@ -1283,7 +1280,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1356,7 +1353,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1418,7 +1415,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1488,7 +1485,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1550,7 +1547,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1615,7 +1612,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . @@ -1683,7 +1680,7 @@ The `Available` property is a way to determine whether data is queued for readin > If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1854,7 +1851,7 @@ The `Available` property is a way to determine whether data is queued for readin When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. It does this by invoking the `Dispose()` method of each referenced object. > [!NOTE] -> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). +> This member outputs trace information when you enable network tracing in your application. ]]> diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index 6e79676c220..3c58fb629c1 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -749,9 +749,9 @@ Exactly one send and one receive is supported on each - Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5. + Returns a value that indicates if the WebSocket instance targets .NET Framework 4.5. - if the is targeting .NET Framework 4.5; otherwise, . + if the targets .NET Framework 4.5; otherwise, . To be added.