diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index a97a2f67f5e..e8a4490f9fb 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -36,16 +36,16 @@ Handles messages based on the WinHTTP interface of Windows. This class is intended for use in server environments. - is similar to other existing classes such as . provides a handler underneath an instance and is used to send HTTP requests out to a server and receive server responses. The implementation supports HTTP versions up to HTTP/2. - - is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. also provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). - - is not intended to be a replacement for . Instead, it's a more advanced version that's provided for scenarios where is insufficient. is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems. - + is similar to other existing classes such as . provides a handler underneath an instance and is used to send HTTP requests out to a server and receive server responses. The implementation supports HTTP versions up to HTTP/2. + + provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). + + is not intended to be a replacement for . Instead, it's a more advanced version that's provided for scenarios where is insufficient. is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems. + When using a chain of multiple handlers, should be at the bottom of the chain. This class is also available for use in Desktop apps by installing it as a NuGet package. For more information, see [System.Net.Http.WinHttpHandler NuGet package](https://www.nuget.org/packages/System.Net.Http.WinHttpHandler/). @@ -98,11 +98,11 @@ Starting in .NET 5, is no longer included Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response. To be added. - @@ -130,12 +130,12 @@ Starting in .NET 5, is no longer included to follow HTTP redirection responses; otherwise, . The default is . - @@ -187,11 +187,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates if the certificate is automatically picked from the certificate store or if the caller is allowed to pass in a specific client certificate. To be added. - . - + . + ]]> @@ -224,11 +224,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets a collection of client authentication SSL certificates that are used for client authentication by the handler if the property is set to . To be added. - @@ -256,11 +256,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the managed cookie container object. This property is only used when the property is set to UseSpecifiedCookieContainer. Otherwise, the method will throw an exception. To be added. - @@ -287,11 +287,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates how cookies should be managed and used. Developers can choose to ignore cookies, allow the handler to automatically manage them or manually handle them using a object. To be added. - . If this value is set to , then a container object must be initialized and assigned to the property. Otherwise, an exception will be thrown when trying to send a request. - + . If this value is set to , then a container object must be initialized and assigned to the property. Otherwise, an exception will be thrown when trying to send a request. + ]]> @@ -316,16 +316,9 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Net.ICredentials - Gets or sets the credentials used to authenticate the user to an authenticating proxy. - To be added. - - . - - ]]> - + When the default (system) proxy is used, gets or sets the credentials used to submit to the default proxy server for authentication. + The credentials used to authenticate the user to an authenticating proxy. + To be added. @@ -412,11 +405,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum number of allowed HTTP redirects. The maximum number of allowed HTTP redirects. - is set to `true`. - + is set to `true`. + ]]> @@ -443,11 +436,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum number of TCP connections allowed to a single server. The maximum number of TCP connections allowed to a single server. - @@ -474,11 +467,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum amount of data that can be drained from responses in bytes. The maximum amount of data that can be drained from responses in bytes. - @@ -502,14 +495,14 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Int32 - Gets or sets the maximum size of the header portion from the server response in bytes. - The maximum size of the header portion from the server response in bytes. + Gets or sets the maximum length, in kilobytes (1024 bytes), of the response headers. + The maximum length, in kilobytes (1024 bytes), of the response headers. - @@ -536,11 +529,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates whether the handler sends an Authorization header with the request. To be added. - @@ -598,11 +591,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the custom proxy when the property is set to use a custom proxy. To be added. - @@ -629,11 +622,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for receiving the data portion of a response from the server. The timeout for receiving the data portion of a response from the server. - @@ -660,11 +653,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for receiving the headers of a response from the server. The timeout for receiving the headers of a response from the server. - @@ -722,11 +715,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for sending a request. The timeout for sending a request. - @@ -760,11 +753,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a callback method to validate the server certificate. This callback is part of the SSL handshake. The callback should return if the server certificate is considered valid and the request should be sent. Otherwise, return . - @@ -792,11 +785,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the credentials to be used by the client to authenticate to the server. The credentials to be used by the client to authenticate to the server. - @@ -823,11 +816,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the collection of TLS/SSL protocols supported by the client. The collection of TLS/SSL protocols supported by the client. - . + ]]> @@ -950,11 +943,11 @@ Only supported on Windows 10 version 2004 or newer. Gets or sets the proxy setting. This property can be set to disable the proxy, use a custom proxy, or use the proxy settings of WinHTTP or WinInet on the machine. To be added. -