dotnet-api-docs/xml/System.Net/HttpWebResponse.xml at main · dotnet/dotnet-api-docs

History

1696 lines (1563 loc) · 115 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Net.WebResponse</BaseTypeName>

</Base>

<InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>

</Interface>

<InterfaceName>System.IDisposable</InterfaceName>

</Interface>

</Interfaces>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Serializable]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Provides an HTTP-specific implementation of the <see cref="T:System.Net.WebResponse" /> class.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This class contains support for HTTP-specific uses of the properties and methods of the <xref:System.Net.WebResponse> class. The <xref:System.Net.HttpWebResponse> class is used to build HTTP stand-alone client applications that send HTTP requests and receive HTTP responses.

> [!NOTE]

> Do not confuse <xref:System.Net.HttpWebResponse> with the <xref:System.Web.HttpResponse> class that is used in ASP.NET applications and whose methods and properties are exposed through ASP.NET's intrinsic `Response` object.

You should never directly create an instance of the <xref:System.Net.HttpWebResponse> class. Instead, use the instance returned by a call to <xref:System.Net.HttpWebRequest.GetResponse%2A?displayProperty=nameWithType>. You must call either the <xref:System.IO.Stream.Close%2A?displayProperty=nameWithType> or the <xref:System.Net.HttpWebResponse.Close%2A?displayProperty=nameWithType> method to close the response and release the connection for reuse. It is not necessary to call both <xref:System.IO.Stream.Close%2A?displayProperty=nameWithType> and <xref:System.Net.HttpWebResponse.Close%2A?displayProperty=nameWithType>, but doing so does not cause an error.

Common header information returned from the Internet resource is exposed as properties of the class. See the following table for a complete list. Other headers can be read from the <xref:System.Net.HttpWebResponse.Headers> property as name/value pairs.

The following table shows the common HTTP headers that are available through properties of the <xref:System.Net.HttpWebResponse> class.

|Header|Property|

|------------|--------------|

|Content-Encoding|<xref:System.Net.HttpWebResponse.ContentEncoding%2A>|

|Content-Length|<xref:System.Net.HttpWebResponse.ContentLength%2A>|

|Content-Type|<xref:System.Net.HttpWebResponse.ContentType%2A>|

|Last-Modified|<xref:System.Net.HttpWebResponse.LastModified%2A>|

|Server|<xref:System.Net.HttpWebResponse.Server%2A>|

The contents of the response from the Internet resource are returned as a <xref:System.IO.Stream> by calling the <xref:System.Net.HttpWebResponse.GetResponseStream%2A> method.

## Examples

The following example returns an <xref:System.Net.HttpWebResponse> from an <xref:System.Net.HttpWebRequest>.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/Overview/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/Overview/source.vb" id="Snippet1":::

]]></format>

</remarks>

</Docs>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Net.HttpWebResponse" /> class.</summary>

</Docs>

</MemberGroup>

<MemberType>Constructor</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>

</Attribute>

<AttributeName>System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)</AttributeName>

</Attribute>

<AttributeName>System.Obsolete("This API supports the .NET infrastructure and is not intended to be used directly from your code.", true)</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("This API supports the .NET infrastructure and is not intended to be used directly from your code.", true)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Net.HttpWebResponse" /> class.</summary>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Net.HttpWebResponse : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> System.Net.HttpWebResponse" Usage="new System.Net.HttpWebResponse (serializationInfo, streamingContext)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("Serialization has been deprecated for HttpWebResponse.")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")]</AttributeName>

</Attribute>

</Attributes>

</Parameters>

<Docs>

<param name="serializationInfo">A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that contains the information required to serialize the new <see cref="T:System.Net.HttpWebRequest" />.</param>

<param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains the source of the serialized stream that is associated with the new <see cref="T:System.Net.HttpWebRequest" />.</param>

<summary>Initializes a new instance of the <see cref="T:System.Net.HttpWebResponse" /> class from the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> instances.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This constructor implements the <xref:System.Runtime.Serialization.ISerializable> interface for the <xref:System.Net.HttpWebRequest> class.

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the character set of the response.</summary>

<value>A string that contains the character set of the response.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.CharacterSet> property contains a value that describes the character set of the response. This character set information is taken from the header returned with the response.

## Examples

The following example obtains the character set of the response.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/CharacterSet/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/CharacterSet/source.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Close : unit -> unit" Usage="httpWebResponse.Close " />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Docs>

<summary>Closes the response stream.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.Close%2A> method closes the response stream and releases the connection to the resource for reuse by other requests.

You should not access any properties of the <xref:System.Net.HttpWebResponse> object after the call to the `Close` method. On .NET Core, an <xref:System.ObjectDisposedException> is thrown.

You must call either the <xref:System.IO.Stream.Close%2A?displayProperty=nameWithType> or the <xref:System.Net.HttpWebResponse.Close%2A?displayProperty=nameWithType> method to close the stream and release the connection for reuse. It is not necessary to call both <xref:System.IO.Stream.Close%2A?displayProperty=nameWithType> and <xref:System.Net.HttpWebResponse.Close%2A?displayProperty=nameWithType>, but doing so does not cause an error. Failure to close the stream can cause your application to run out of connections.

> [!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 example demonstrates how to close a <xref:System.Net.HttpWebResponse>.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/Close/httpwebresponse_close.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/Close/httpwebresponse_close.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">**.NET Core only:** This <see cref="T:System.Net.HttpWebResponse" /> object has been disposed.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the method that is used to encode the body of the response.</summary>

<value>A string that describes the method that is used to encode the body of the response.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.ContentEncoding> property contains the value of the Content-Encoding header returned with the response.

## Examples

The following example uses the <xref:System.Net.HttpWebResponse.ContentEncoding> property to obtain the value of the Content-Encoding header returned with the response.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/CharacterSet/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/CharacterSet/source.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Int64</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the length of the content returned by the request.</summary>

<value>The number of bytes returned by the request. Content length does not include header information.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.ContentLength> property contains the value of the Content-Length header returned with the response. If the Content-Length header is not set in the response, <xref:System.Net.HttpWebResponse.ContentLength%2A> is set to the value -1.

## Examples

The following example displays the value of this property.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebRequest/Credentials/httpwebrequest1.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebRequest/Credentials/httpwebrequest1.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the content type of the response.</summary>

<value>A string that contains the content type of the response.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.ContentType> property contains the value of the Content-Type header returned with the response.

## Examples

The following example displays the value of this property.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebRequest/Credentials/httpwebrequest1.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebRequest/Credentials/httpwebrequest1.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Net.CookieCollection</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets or sets the cookies that are associated with this response.</summary>

<value>A <see cref="T:System.Net.CookieCollection" /> that contains the cookies that are associated with this response.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.Cookies> property provides an instance of the <xref:System.Net.CookieCollection> class that holds the cookies associated with this response.

If the <xref:System.Net.HttpWebRequest.CookieContainer> property of the associated <xref:System.Net.HttpWebRequest> is `null`, the <xref:System.Net.HttpWebResponse.Cookies> property will also be `null`. Any cookie information sent by the server will be available in the <xref:System.Net.HttpWebResponse.Headers> property, however.

## Examples

The following example sends a request to a URL and displays the cookies returned in the response.

:::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/Cookie/Overview/cookiessnippets.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="httpWebResponse.Dispose disposing" FrameworkAlternate="dotnet-uwp-10.0;net-10.0;net-11.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1" />

<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="httpWebResponse.Dispose disposing" FrameworkAlternate="netframework-1.1" />

<MemberType>Method</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to releases only unmanaged resources.</param>

<summary>Releases the unmanaged resources used by the <see cref="T:System.Net.HttpWebResponse" />, and optionally disposes of the managed resources.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This method is called by the public `Dispose()` method and the <xref:System.Object.Finalize> 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 <xref:System.Net.WebResponse> references. This method invokes the `Dispose()` method of each referenced object.

> [!NOTE]

]]></format>

</remarks>

<para>

<see langword="Dispose" /> can be called multiple times by other objects. When overriding <see cref="M:System.Net.HttpWebResponse.Dispose(System.Boolean)" />, be careful not to reference objects that have been previously disposed of in an earlier call to <see langword="Dispose" />. For more information about how to implement <see cref="M:System.Net.HttpWebResponse.Dispose(System.Boolean)" />, see <see href="/dotnet/standard/garbage-collection/implementing-dispose">Implementing a Dispose Method</see>.

For more information about <see langword="Dispose" /> and <see cref="M:System.Object.Finalize" />, see <see href="/dotnet/standard/garbage-collection/unmanaged">Cleaning Up Unmanaged Resources</see> and <see href="https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)">Overriding the Finalize Method</see>.</para>

</block>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="httpWebResponse.GetHashCode " />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Docs>

<summary>Returns a hash value for a <see cref="T:System.Net.HttpWebResponse" /> instance.</summary>

<returns>An integer hash value.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The GetHashCode method returns a hash code of the web response instance. This value can be used as a key in hash tables.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetObjectData : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> unit" Usage="httpWebResponse.GetObjectData (serializationInfo, streamingContext)" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Obsolete("Serialization has been deprecated for HttpWebResponse.")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="serializationInfo">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>

<param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies the destination for this serialization.</param>

<summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the target object.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

Any objects that are included in the <xref:System.Runtime.Serialization.SerializationInfo> are automatically tracked and serialized by the formatter.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.GetResponseHeader : string -> string" Usage="httpWebResponse.GetResponseHeader headerName" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="headerName">The header value to return.</param>

<summary>Gets the contents of a header that was returned with the response.</summary>

<returns>The contents of the specified header.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

Use <xref:System.Net.HttpWebResponse.GetResponseHeader%2A> to retrieve the contents of particular headers. You must specify which header you want to return.

## Examples

This example creates a Web request and queries for a response. If the site requires authentication, this example will respond with a challenge string. This string is extracted using <xref:System.Net.HttpWebResponse.GetResponseHeader%2A>.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/GetResponseHeader/httpwebresponse_getresponseheader.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/GetResponseHeader/httpwebresponse_getresponseheader.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetResponseStream : unit -> System.IO.Stream" Usage="httpWebResponse.GetResponseStream " />

<MemberType>Method</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Net</AssemblyName>

</AssemblyInfo>

<ReturnType>System.IO.Stream</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the stream that is used to read the body of the response from the server.</summary>

<returns>A <see cref="T:System.IO.Stream" /> containing the body of the response.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.HttpWebResponse.GetResponseStream%2A> method returns the data stream from the requested Internet resource.

> [!NOTE]

> You must call one of the <xref:System.IO.Stream.Close%2A?displayProperty=nameWithType>, <xref:System.IO.Stream.Dispose%2A?displayProperty=nameWithType>, <xref:System.Net.HttpWebResponse.Close%2A?displayProperty=nameWithType>, or <xref:System.Net.HttpWebResponse.Dispose%2A?displayProperty=nameWithType> methods to close the stream and release the connection for reuse. It's not necessary to close or dispose both <xref:System.IO.Stream> and <xref:System.Net.HttpWebResponse> instances, but doing so doesn't cause an error. Failure to close or dispose the stream will cause your application to run out of connections.

> [!NOTE]

## Examples

The following example demonstrates how to use <xref:System.Net.HttpWebResponse.GetResponseStream%2A> to return the <xref:System.IO.Stream> instance used to read the response from the server.

:::code language="csharp" source="~/snippets/csharp/System.Net/HttpWebResponse/GetResponseStream/httpwebresponse_getresponsestream.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Net/HttpWebResponse/GetResponseStream/httpwebresponse_getresponsestream.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.Net.ProtocolViolationException">There is no response stream.</exception>

<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.Net.Requests</AssemblyName>

</AssemblyInfo>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

HttpWebResponse.xml

Latest commit

History

HttpWebResponse.xml

File metadata and controls