Skip to content

Commit df5f6d1

Browse files
ManickaPManickaP
committed
Fix default value for AutomaticDecompression
1 parent e4006f0 commit df5f6d1

File tree

1 file changed

+106
-106
lines changed

1 file changed

+106
-106
lines changed

‎xml/System.Net.Http/WinHttpHandler.xml‎

Lines changed: 106 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@
3636
<summary>
3737
Handles messages based on the WinHTTP interface of Windows. This class is intended for use in server environments.</summary>
3838
<remarks>
39-
<format type="text/markdown"><![CDATA[
40-
39+
<format type="text/markdown"><![CDATA[
40+
4141
## Remarks
4242
43-
<xref:System.Net.Http.WinHttpHandler> is similar to other existing classes such as <xref:System.Net.Http.HttpClientHandler>. <xref:System.Net.Http.WinHttpHandler> provides a handler underneath an <xref:System.Net.Http.HttpClient> instance and is used to send HTTP requests out to a server and receive server responses. The <xref:System.Net.Http.WinHttpHandler> implementation supports HTTP versions up to HTTP/2.
44-
45-
<xref:System.Net.Http.WinHttpHandler> is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. <xref:System.Net.Http.WinHttpHandler> also provides developers with more granular control over the application's HTTP communication than the <xref:System.Net.Http.HttpClientHandler> class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation).
46-
47-
<xref:System.Net.Http.WinHttpHandler> is not intended to be a replacement for <xref:System.Net.Http.HttpClientHandler>. Instead, it's a more advanced version that's provided for scenarios where <xref:System.Net.Http.HttpClientHandler> is insufficient. <xref:System.Net.Http.WinHttpHandler> is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems.
48-
43+
<xref:System.Net.Http.WinHttpHandler> is similar to other existing classes such as <xref:System.Net.Http.HttpClientHandler>. <xref:System.Net.Http.WinHttpHandler> provides a handler underneath an <xref:System.Net.Http.HttpClient> instance and is used to send HTTP requests out to a server and receive server responses. The <xref:System.Net.Http.WinHttpHandler> implementation supports HTTP versions up to HTTP/2.
44+
45+
<xref:System.Net.Http.WinHttpHandler> is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. <xref:System.Net.Http.WinHttpHandler> also provides developers with more granular control over the application's HTTP communication than the <xref:System.Net.Http.HttpClientHandler> class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation).
46+
47+
<xref:System.Net.Http.WinHttpHandler> is not intended to be a replacement for <xref:System.Net.Http.HttpClientHandler>. Instead, it's a more advanced version that's provided for scenarios where <xref:System.Net.Http.HttpClientHandler> is insufficient. <xref:System.Net.Http.WinHttpHandler> is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems.
48+
4949
When using a chain of multiple handlers, <xref:System.Net.Http.WinHttpHandler> should be at the bottom of the chain.
5050
5151
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, <xref:System.Net.Http.WinHttpHandler> is no longer included
9898
<summary>Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response.</summary>
9999
<value>To be added.</value>
100100
<remarks>
101-
<format type="text/markdown"><![CDATA[
102-
103-
## Remarks
104-
The default value for this property is `GZip | Deflate`.
105-
101+
<format type="text/markdown"><![CDATA[
102+
103+
## Remarks
104+
The default value for this property is `None`.
105+
106106
]]></format>
107107
</remarks>
108108
</Docs>
@@ -130,12 +130,12 @@ Starting in .NET 5, <xref:System.Net.Http.WinHttpHandler> is no longer included
130130
<value>
131131
<see langword="true" /> to follow HTTP redirection responses; otherwise, <see langword="false" />. The default is <see langword="true" />.</value>
132132
<remarks>
133-
<format type="text/markdown"><![CDATA[
134-
133+
<format type="text/markdown"><![CDATA[
134+
135135
## Remarks
136136
137-
When this property is set to `true`, all HTTP redirect responses from the server will be followed automatically except if they are redirecting from an HTTPS endpoint to an HTTP endpoint.
138-
137+
When this property is set to `true`, all HTTP redirect responses from the server will be followed automatically except if they are redirecting from an HTTPS endpoint to an HTTP endpoint.
138+
139139
]]></format>
140140
</remarks>
141141
</Docs>
@@ -187,11 +187,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
187187
<summary>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.</summary>
188188
<value>To be added.</value>
189189
<remarks>
190-
<format type="text/markdown"><![CDATA[
191-
192-
## Remarks
193-
The default value for this property is <xref:System.Net.Http.ClientCertificateOption.Manual?displayProperty=nameWithType>.
194-
190+
<format type="text/markdown"><![CDATA[
191+
192+
## Remarks
193+
The default value for this property is <xref:System.Net.Http.ClientCertificateOption.Manual?displayProperty=nameWithType>.
194+
195195
]]></format>
196196
</remarks>
197197
</Docs>
@@ -224,11 +224,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
224224
<summary>Gets a collection of client authentication SSL certificates that are used for client authentication by the handler if the <see cref="P:System.Net.Http.WinHttpHandler.ClientCertificateOption" /> property is set to <see langword="Manual" />.</summary>
225225
<value>To be added.</value>
226226
<remarks>
227-
<format type="text/markdown"><![CDATA[
228-
229-
## Remarks
230-
The default value for this property is an empty collection.
231-
227+
<format type="text/markdown"><![CDATA[
228+
229+
## Remarks
230+
The default value for this property is an empty collection.
231+
232232
]]></format>
233233
</remarks>
234234
</Docs>
@@ -256,11 +256,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
256256
<summary>Gets or sets the managed cookie container object. This property is only used when the <see cref="P:System.Net.Http.WinHttpHandler.CookieUsePolicy" /> property is set to UseSpecifiedCookieContainer. Otherwise, the <see cref="M:System.Net.Http.WinHttpHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)" /> method will throw an exception.</summary>
257257
<value>To be added.</value>
258258
<remarks>
259-
<format type="text/markdown"><![CDATA[
260-
261-
## Remarks
262-
The default value for this property is `null`.
263-
259+
<format type="text/markdown"><![CDATA[
260+
261+
## Remarks
262+
The default value for this property is `null`.
263+
264264
]]></format>
265265
</remarks>
266266
</Docs>
@@ -287,11 +287,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
287287
<summary>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 <see cref="T:System.Net.CookieContainer" /> object.</summary>
288288
<value>To be added.</value>
289289
<remarks>
290-
<format type="text/markdown"><![CDATA[
291-
292-
## Remarks
293-
The default for this property is <xref:System.Net.Http.CookieUsePolicy.UseInternalCookieStoreOnly?displayProperty=nameWithType>. If this value is set to <xref:System.Net.Http.CookieUsePolicy.UseSpecifiedCookieContainer?displayProperty=nameWithType>, then a container object must be initialized and assigned to the <xref:System.Net.Http.WinHttpHandler.CookieContainer%2A> property. Otherwise, an exception will be thrown when trying to send a request.
294-
290+
<format type="text/markdown"><![CDATA[
291+
292+
## Remarks
293+
The default for this property is <xref:System.Net.Http.CookieUsePolicy.UseInternalCookieStoreOnly?displayProperty=nameWithType>. If this value is set to <xref:System.Net.Http.CookieUsePolicy.UseSpecifiedCookieContainer?displayProperty=nameWithType>, then a container object must be initialized and assigned to the <xref:System.Net.Http.WinHttpHandler.CookieContainer%2A> property. Otherwise, an exception will be thrown when trying to send a request.
294+
295295
]]></format>
296296
</remarks>
297297
</Docs>
@@ -319,11 +319,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
319319
<summary>Gets or sets the credentials used to authenticate the user to an authenticating proxy.</summary>
320320
<value>To be added.</value>
321321
<remarks>
322-
<format type="text/markdown"><![CDATA[
323-
324-
## Remarks
325-
The default value for this property is <xref:System.Net.CredentialCache.DefaultCredentials?displayProperty=nameWithType>.
326-
322+
<format type="text/markdown"><![CDATA[
323+
324+
## Remarks
325+
The default value for this property is <xref:System.Net.CredentialCache.DefaultCredentials?displayProperty=nameWithType>.
326+
327327
]]></format>
328328
</remarks>
329329
</Docs>
@@ -412,11 +412,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
412412
<summary>Gets or sets the maximum number of allowed HTTP redirects.</summary>
413413
<value>The maximum number of allowed HTTP redirects.</value>
414414
<remarks>
415-
<format type="text/markdown"><![CDATA[
416-
417-
## Remarks
418-
The default value for this property is 50. This value only applies if <xref:System.Net.Http.WinHttpHandler.AutomaticRedirection%2A> is set to `true`.
419-
415+
<format type="text/markdown"><![CDATA[
416+
417+
## Remarks
418+
The default value for this property is 50. This value only applies if <xref:System.Net.Http.WinHttpHandler.AutomaticRedirection%2A> is set to `true`.
419+
420420
]]></format>
421421
</remarks>
422422
</Docs>
@@ -443,11 +443,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
443443
<summary>Gets or sets the maximum number of TCP connections allowed to a single server.</summary>
444444
<value>The maximum number of TCP connections allowed to a single server.</value>
445445
<remarks>
446-
<format type="text/markdown"><![CDATA[
447-
448-
## Remarks
449-
The default value for this property is `int.MaxValue`.
450-
446+
<format type="text/markdown"><![CDATA[
447+
448+
## Remarks
449+
The default value for this property is `int.MaxValue`.
450+
451451
]]></format>
452452
</remarks>
453453
</Docs>
@@ -474,11 +474,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
474474
<summary>Gets or sets the maximum amount of data that can be drained from responses in bytes.</summary>
475475
<value>The maximum amount of data that can be drained from responses in bytes.</value>
476476
<remarks>
477-
<format type="text/markdown"><![CDATA[
478-
479-
## Remarks
480-
The default value for this property is 65536.
481-
477+
<format type="text/markdown"><![CDATA[
478+
479+
## Remarks
480+
The default value for this property is 65536.
481+
482482
]]></format>
483483
</remarks>
484484
</Docs>
@@ -505,11 +505,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
505505
<summary>Gets or sets the maximum size of the header portion from the server response in bytes.</summary>
506506
<value>The maximum size of the header portion from the server response in bytes.</value>
507507
<remarks>
508-
<format type="text/markdown"><![CDATA[
509-
510-
## Remarks
511-
This property protects the client from an unauthorized server attempting to stall the client by sending a response with an infinite amount of header data. The default value for this property is 65536.
512-
508+
<format type="text/markdown"><![CDATA[
509+
510+
## Remarks
511+
This property protects the client from an unauthorized server attempting to stall the client by sending a response with an infinite amount of header data. The default value for this property is 65536.
512+
513513
]]></format>
514514
</remarks>
515515
</Docs>
@@ -536,11 +536,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
536536
<summary>Gets or sets a value that indicates whether the handler sends an Authorization header with the request.</summary>
537537
<value>To be added.</value>
538538
<remarks>
539-
<format type="text/markdown"><![CDATA[
540-
541-
## Remarks
542-
The default value for this property is `false`.
543-
539+
<format type="text/markdown"><![CDATA[
540+
541+
## Remarks
542+
The default value for this property is `false`.
543+
544544
]]></format>
545545
</remarks>
546546
</Docs>
@@ -598,11 +598,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
598598
<summary>Gets or sets the custom proxy when the <see cref="P:System.Net.Http.WinHttpHandler.WindowsProxyUsePolicy" /> property is set to use a custom proxy.</summary>
599599
<value>To be added.</value>
600600
<remarks>
601-
<format type="text/markdown"><![CDATA[
602-
603-
## Remarks
604-
The default value for this property is `null`.
605-
601+
<format type="text/markdown"><![CDATA[
602+
603+
## Remarks
604+
The default value for this property is `null`.
605+
606606
]]></format>
607607
</remarks>
608608
</Docs>
@@ -629,11 +629,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
629629
<summary>Gets or sets the timeout for receiving the data portion of a response from the server.</summary>
630630
<value>The timeout for receiving the data portion of a response from the server.</value>
631631
<remarks>
632-
<format type="text/markdown"><![CDATA[
633-
634-
## Remarks
635-
The default value for this property is 30 seconds.
636-
632+
<format type="text/markdown"><![CDATA[
633+
634+
## Remarks
635+
The default value for this property is 30 seconds.
636+
637637
]]></format>
638638
</remarks>
639639
</Docs>
@@ -660,11 +660,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
660660
<summary>Gets or sets the timeout for receiving the headers of a response from the server.</summary>
661661
<value>The timeout for receiving the headers of a response from the server.</value>
662662
<remarks>
663-
<format type="text/markdown"><![CDATA[
664-
665-
## Remarks
666-
The default value for this property is 30 seconds.
667-
663+
<format type="text/markdown"><![CDATA[
664+
665+
## Remarks
666+
The default value for this property is 30 seconds.
667+
668668
]]></format>
669669
</remarks>
670670
</Docs>
@@ -722,11 +722,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
722722
<summary>Gets or sets the timeout for sending a request.</summary>
723723
<value>The timeout for sending a request.</value>
724724
<remarks>
725-
<format type="text/markdown"><![CDATA[
726-
727-
## Remarks
728-
The default value for this property is 30 seconds.
729-
725+
<format type="text/markdown"><![CDATA[
726+
727+
## Remarks
728+
The default value for this property is 30 seconds.
729+
730730
]]></format>
731731
</remarks>
732732
</Docs>
@@ -760,11 +760,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
760760
<summary>Gets or sets a callback method to validate the server certificate. This callback is part of the SSL handshake.</summary>
761761
<value>The callback should return <see langword="true" /> if the server certificate is considered valid and the request should be sent. Otherwise, return <see langword="false" />.</value>
762762
<remarks>
763-
<format type="text/markdown"><![CDATA[
764-
765-
## Remarks
766-
The default value is `null`. If this property is `null`, the server certificate is validated using standard well-known certificate authorities.
767-
763+
<format type="text/markdown"><![CDATA[
764+
765+
## Remarks
766+
The default value is `null`. If this property is `null`, the server certificate is validated using standard well-known certificate authorities.
767+
768768
]]></format>
769769
</remarks>
770770
</Docs>
@@ -792,11 +792,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
792792
<summary>Gets or sets the credentials to be used by the client to authenticate to the server.</summary>
793793
<value>The credentials to be used by the client to authenticate to the server.</value>
794794
<remarks>
795-
<format type="text/markdown"><![CDATA[
796-
797-
## Remarks
798-
The default value for this property is `null`.
799-
795+
<format type="text/markdown"><![CDATA[
796+
797+
## Remarks
798+
The default value for this property is `null`.
799+
800800
]]></format>
801801
</remarks>
802802
</Docs>
@@ -823,11 +823,11 @@ When this property is set to `true`, all HTTP redirect responses from the server
823823
<summary>Gets or sets the collection of TLS/SSL protocols supported by the client.</summary>
824824
<value>The collection of TLS/SSL protocols supported by the client.</value>
825825
<remarks>
826-
<format type="text/markdown"><![CDATA[
827-
828-
## Remarks
826+
<format type="text/markdown"><![CDATA[
827+
828+
## Remarks
829829
The default value is `SslProtocols.Tls | SslProtocols.Tls11 | SslProtocols.Tls12`.
830-
830+
831831
]]></format>
832832
</remarks>
833833
</Docs>
@@ -950,11 +950,11 @@ Only supported on Windows 10 version 2004 or newer.
950950
<summary>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.</summary>
951951
<value>To be added.</value>
952952
<remarks>
953-
<format type="text/markdown"><![CDATA[
954-
955-
## Remarks
956-
The default value of this property is the WinHTTP stack proxy settings.
957-
953+
<format type="text/markdown"><![CDATA[
954+
955+
## Remarks
956+
The default value of this property is the WinHTTP stack proxy settings.
957+
958958
]]></format>
959959
</remarks>
960960
</Docs>

0 commit comments

Comments
 (0)