1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="StreamWriter" FullName="System.IO.StreamWriter" FullNameSP="System_IO_StreamWriter" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public serializable StreamWriter extends System.IO.TextWriter" />
<TypeSignature Language="C#" Value="public class StreamWriter : System.IO.TextWriter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit StreamWriter extends System.IO.TextWriter" />
<MemberOfLibrary>BCL</MemberOfLibrary>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
<Base>
<BaseTypeName>System.IO.TextWriter</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.IO.StreamWriter" /> is designed for character output in a particular encoding, whereas classes derived from <see cref="T:System.IO.Stream" /> are designed for byte input and output.</para>
<para>
<see cref="T:System.IO.StreamWriter" /> defaults to using an instance of <see cref="T:System.Text.UTF8Encoding" /> unless specified otherwise. This instance of UTF8Encoding is constructed without a byte order mark (BOM), so its <see cref="M:System.Text.Encoding.GetPreamble" /> method returns an empty byte array. The default UTF-8 encoding for this constructor throws an exception on invalid bytes. This behavior is different from the behavior provided by the encoding object in the <see cref="P:System.Text.Encoding.UTF8" /> property. To specify a BOM and determine whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as <see cref="M:System.IO.StreamWriter.#ctor(System.String,System.Boolean,System.Text.Encoding)" /> or <see cref="M:System.IO.StreamWriter.#ctor(System.IO.Stream,System.Text.Encoding)" />.</para>
<para>By default, a <see cref="T:System.IO.StreamWriter" /> is not thread safe. See <see cref="M:System.IO.TextWriter.Synchronized(System.IO.TextWriter)" /> for a thread-safe wrapper.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a <see cref="T:System.IO.TextWriter" /> for writing characters to a stream in a particular encoding.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.IO.Stream stream)" />
<MemberSignature Language="C#" Value="public StreamWriter (System.IO.Stream stream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentException">
<paramref name="stream " />does not support writing.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream " /> is <see langword="null" />.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor creates a <see cref="T:System.IO.StreamWriter" /> with UTF-8 encoding without a Byte-Order Mark (BOM), so its <see cref="M:System.Text.Encoding.GetPreamble" /> method returns an empty byte array. The default UTF-8 encoding for this constructor throws an exception on invalid bytes. This behavior is different from the behavior provided by the encoding object in the <see cref="P:System.Text.Encoding.UTF8" /> property. To specify whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as <see cref="M:System.IO.StreamWriter.#ctor(System.IO.Stream,System.Text.Encoding)" />. The <see cref="P:System.IO.StreamWriter.BaseStream" /> property is initialized using the <paramref name="stream" /> parameter. The position of the stream is not reset.</para>
<para>The <see cref="T:System.IO.StreamWriter" /> object calls <see cref="M:System.IO.Stream.Dispose" /> on the provided <see cref="T:System.IO.Stream" /> object when <see cref="M:System.IO.StreamWriter.Dispose(System.Boolean)" /> is called.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified stream by using UTF-8 encoding and the default buffer size.</para>
</summary>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream to write to. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string path)" />
<MemberSignature Language="C#" Value="public StreamWriter (string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<exception cref="T:System.IO.IOException">
<paramref name="path" /> is in an invalid format or contains invalid characters.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The directory information specified in <paramref name="path" /> was not found.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access to <paramref name="path" /> is denied.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path " />is an empty string ("").</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="path " />is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Requires permission for reading and writing files. See <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Read" qualify="true" />, <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Write" qualify="true" /></permission>
<exception cref="T:System.IO.PathTooLongException">The length of <paramref name="path" /> or the absolute path information for <paramref name="path" /> exceeds the implementation-specific maximum length.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor creates a <see cref="T:System.IO.StreamWriter" /> with UTF-8 encoding without a Byte-Order Mark (BOM), so its <see cref="M:System.Text.Encoding.GetPreamble" /> method returns an empty byte array. The default UTF-8 encoding for this constructor throws an exception on invalid bytes. This behavior is different from the behavior provided by the encoding object in the <see cref="P:System.Text.Encoding.UTF8" /> property. To specify a BOM and determine whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as <see cref="M:System.IO.StreamWriter.#ctor(System.String,System.Boolean,System.Text.Encoding)" />. </para>
<para>The <paramref name="path" /> parameter can be a file name, including a file on a Universal Naming Convention (UNC) share. If the file exists, it is overwritten; otherwise, a new file is created.</para>
<para>The <paramref name="path" /> parameter is not required to be a file stored on disk; it can be any part of a system that supports access using streams.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified file by using the default encoding and buffer size.</para>
</summary>
<param name="path">
<attribution license="cc4" from="Microsoft" modified="false" />The complete file path to write to. <paramref name="path" /> can be a file name. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.IO.Stream stream, class System.Text.Encoding encoding)" />
<MemberSignature Language="C#" Value="public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream, class System.Text.Encoding encoding) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream " /> or <paramref name="encoding " /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="stream" /> does not support writing.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor initializes the <see cref="P:System.IO.StreamWriter.Encoding" /> property using the encoding parameter, and the <see cref="P:System.IO.StreamWriter.BaseStream" /> property using the stream parameter. The position of the stream is not reset. For additional information, see <see cref="P:System.IO.TextWriter.Encoding" />.</para>
<para>The <see cref="T:System.IO.StreamWriter" /> object calls <see cref="M:System.IO.Stream.Dispose" /> on the provided <see cref="T:System.IO.Stream" /> object when <see cref="M:System.IO.StreamWriter.Dispose(System.Boolean)" /> is called.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified stream by using the specified encoding and the default buffer size.</para>
</summary>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream to write to. </param>
<param name="encoding">
<attribution license="cc4" from="Microsoft" modified="false" />The character encoding to use. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string path, bool append)" />
<MemberSignature Language="C#" Value="public StreamWriter (string path, bool append);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, bool append) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="append" Type="System.Boolean" />
</Parameters>
<Docs>
<exception cref="T:System.IO.IOException">A general I/O exception occurs, such as trying to access a CD-ROM drive whose tray is open</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The directory information specified in <paramref name="path" /> was not found.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access to <paramref name="path" /> is denied. The caller does not have the required permission.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path " /> is a zero-length string, contains only white space, or contains one or more implementation-specific invalid characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="path " />is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Requires permission for reading and writing files. See <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Read" qualify="true" />, <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Write" qualify="true" /></permission>
<exception cref="T:System.IO.NotSupportedException">
<paramref name="path " /> is in an implementation-specific invalid format.</exception>
<exception cref="T:System.IO.PathTooLongException">The length of <paramref name="path" /> or the absolute path information for <paramref name="path" /> exceeds the implementation-specific maximum length.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor creates a <see cref="T:System.IO.StreamWriter" /> with UTF-8 encoding without a Byte-Order Mark (BOM), so its <see cref="M:System.Text.Encoding.GetPreamble" /> method returns an empty byte array. The default UTF-8 encoding for this constructor throws an exception on invalid bytes. This behavior is different from the behavior provided by the encoding object in the <see cref="P:System.Text.Encoding.UTF8" /> property. To specify a BOM and determine whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as <see cref="M:System.IO.StreamWriter.#ctor(System.String,System.Boolean,System.Text.Encoding)" />. </para>
<para>The <paramref name="path" /> parameter can be a file name, including a file on a Universal Naming Convention (UNC) share.</para>
<para>The <paramref name="path" /> parameter is not required to be a file stored on disk; it can be any part of a system that supports access using streams.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified file by using the default encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.</para>
</summary>
<param name="path">
<attribution license="cc4" from="Microsoft" modified="false" />The complete file path to write to. </param>
<param name="append">
<attribution license="cc4" from="Microsoft" modified="false" />true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.IO.Stream stream, class System.Text.Encoding encoding, int32 bufferSize)" />
<MemberSignature Language="C#" Value="public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding, int bufferSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream, class System.Text.Encoding encoding, int32 bufferSize) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
<Parameter Name="bufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream " /> or <paramref name="encoding " /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="bufferSize " /> is negative.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="stream" /> does not support writing.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor initializes the <see cref="P:System.IO.StreamWriter.Encoding" /> property using the <paramref name="encoding" /> parameter, and the <see cref="P:System.IO.StreamWriter.BaseStream" /> property using the <paramref name="stream" /> parameter. The position of the stream is not reset. For additional information, see <see cref="P:System.IO.TextWriter.Encoding" />.</para>
<para>The <see cref="T:System.IO.StreamWriter" /> object calls <see cref="M:System.IO.Stream.Dispose" /> on the provided <see cref="T:System.IO.Stream" /> object when <see cref="M:System.IO.StreamWriter.Dispose(System.Boolean)" /> is called.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified stream by using the specified encoding and buffer size.</para>
</summary>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream to write to. </param>
<param name="encoding">
<attribution license="cc4" from="Microsoft" modified="false" />The character encoding to use. </param>
<param name="bufferSize">
<attribution license="cc4" from="Microsoft" modified="false" />The buffer size, in bytes. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string path, bool append, class System.Text.Encoding encoding)" />
<MemberSignature Language="C#" Value="public StreamWriter (string path, bool append, System.Text.Encoding encoding);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, bool append, class System.Text.Encoding encoding) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="append" Type="System.Boolean" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
</Parameters>
<Docs>
<exception cref="T:System.IO.IOException">A general I/O exception occurred, such as trying to access a CD-ROM drive whose tray is open.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The directory information specified in <paramref name="path" /> was not found.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access is denied. The caller does not have the required permission.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path " /> is a zero-length string, contains only white space, or contains one or more implementation-specific invalid characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="path " /> or <paramref name="encoding" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Requires permission for reading and writing files. See <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Read" qualify="true" />, <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Write" qualify="true" /></permission>
<exception cref="T:System.IO.NotSupportedException">
<paramref name="path " /> is in an implementation-specific invalid format.</exception>
<exception cref="T:System.IO.PathTooLongException">The length of <paramref name="path" /> or the absolute path information for <paramref name="path" /> exceeds the implementation-specific maximum length.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor initializes the <see cref="P:System.IO.StreamWriter.Encoding" /> property using the encoding parameter. For additional information, see <see cref="P:System.IO.TextWriter.Encoding" />.</para>
<para>
<paramref name="path" /> can be a file name, including a file on a Universal Naming Convention (UNC) share.</para>
<para>
<paramref name="path" /> is not required to be a file stored on disk; it can be any part of a system that supports access via streams.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified file by using the specified encoding and default buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.</para>
</summary>
<param name="path">
<attribution license="cc4" from="Microsoft" modified="false" />The complete file path to write to. </param>
<param name="append">
<attribution license="cc4" from="Microsoft" modified="false" />true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.</param>
<param name="encoding">
<attribution license="cc4" from="Microsoft" modified="false" />The character encoding to use. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding, int bufferSize, bool leaveOpen);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream, class System.Text.Encoding encoding, int32 bufferSize, bool leaveOpen) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
<Parameter Name="bufferSize" Type="System.Int32" />
<Parameter Name="leaveOpen" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Unless you set the <paramref name="leaveOpen" /> parameter to true, the <see cref="T:System.IO.StreamWriter" /> object calls <see cref="M:System.IO.Stream.Dispose" /> on the provided <see cref="T:System.IO.Stream" /> object when <see cref="M:System.IO.StreamWriter.Dispose(System.Boolean)" /> is called.</para>
<para>This constructor initializes the <see cref="P:System.IO.StreamWriter.Encoding" /> property by using the <paramref name="encoding" /> parameter, and initializes the <see cref="P:System.IO.StreamWriter.BaseStream" /> property by using the <paramref name="stream" /> parameter. The position of the stream is not reset. For additional information, see the <see cref="P:System.IO.TextWriter.Encoding" /> property.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified stream by using the specified encoding and buffer size, and optionally leaves the stream open.</para>
</summary>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream to write to.</param>
<param name="encoding">
<attribution license="cc4" from="Microsoft" modified="false" />The character encoding to use.</param>
<param name="bufferSize">
<attribution license="cc4" from="Microsoft" modified="false" />The buffer size, in bytes.</param>
<param name="leaveOpen">
<attribution license="cc4" from="Microsoft" modified="false" />true to leave the stream open after the <see cref="T:System.IO.StreamWriter" /> object is disposed; otherwise, false.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string path, bool append, class System.Text.Encoding encoding, int32 bufferSize)" />
<MemberSignature Language="C#" Value="public StreamWriter (string path, bool append, System.Text.Encoding encoding, int bufferSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, bool append, class System.Text.Encoding encoding, int32 bufferSize) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="append" Type="System.Boolean" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
<Parameter Name="bufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<exception cref="T:System.IO.IOException">A general I/O exception occurred, such as trying to access a CD-ROM drive whose tray is open.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The directory information specified in <paramref name="path" /> was not found.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="path " /> is a zero-length string, contains only white space, or contains one or more implementation-specific invalid characters.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="path" /> or <paramref name="encoding" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="bufferSize " /> is negative.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
<exception cref="T:System.UnauthorizedAccessException">Access is denied. The caller does not have the required permission.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Requires permission for reading and writing files. See <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Read" qualify="true" />, <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Write" qualify="true" /></permission>
<exception cref="T:System.IO.NotSupportedException">
<paramref name="path" /> is in an implementation-specific invalid format.</exception>
<exception cref="T:System.IO.PathTooLongException">The length of <paramref name="path" /> or the absolute path information for <paramref name="path" /> exceeds the implementation-specific maximum length.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor initializes the <see cref="P:System.IO.StreamWriter.Encoding" /> property using the encoding parameter. For additional information, see <see cref="P:System.IO.TextWriter.Encoding" />.</para>
<para>
<paramref name="path" /> can be a file name, including a file on a Universal Naming Convention (UNC) share.</para>
<para>
<paramref name="path" /> is not required to be a file stored on disk; it can be any part of a system that supports access via streams.</para>
<block subset="none" type="note">
<para>When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.</para>
</block>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.IO.StreamWriter" /> class for the specified file on the specified path, using the specified encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.</para>
</summary>
<param name="path">
<attribution license="cc4" from="Microsoft" modified="false" />The complete file path to write to. </param>
<param name="append">
<attribution license="cc4" from="Microsoft" modified="false" />true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.</param>
<param name="encoding">
<attribution license="cc4" from="Microsoft" modified="false" />The character encoding to use. </param>
<param name="bufferSize">
<attribution license="cc4" from="Microsoft" modified="false" />The buffer size, in bytes. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="AutoFlush">
<MemberSignature Language="ILASM" Value=".property bool AutoFlush { public hidebysig virtual specialname bool get_AutoFlush() public hidebysig virtual specialname void set_AutoFlush(bool value) }" />
<MemberSignature Language="C#" Value="public virtual bool AutoFlush { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AutoFlush" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>
<para>
<see langword="true" /> to force
<see cref="T:System.IO.StreamWriter" /> to flush its
buffer; otherwise, <see langword="false" />.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Flushing the stream will not flush its underlying encoder unless you explicitly call <see cref="M:System.IO.StreamWriter.Flush" /> or <see cref="M:System.IO.StreamWriter.Close" />. Setting <see cref="P:System.IO.StreamWriter.AutoFlush" /> to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.</para>
<para>When AutoFlush is set to false, StreamWriter will do a limited amount of buffering, both internally and potentially in the encoder from the encoding you passed in. You can get better performance by setting AutoFlush to false, assuming that you always call Close (or at least Flush) when you're done writing with a StreamWriter.</para>
<para>For example, set AutoFlush to true when you are writing to a device where the user expects immediate feedback. Console.Out is one of these cases: The StreamWriter used internally for writing to Console flushes all its internal state except the encoder state after every call to <see cref="M:System.IO.StreamWriter.Write(System.Char)" />.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the <see cref="T:System.IO.StreamWriter" /> will flush its buffer to the underlying stream after every call to <see cref="M:System.IO.StreamWriter.Write(System.Char)" />.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BaseStream">
<MemberSignature Language="ILASM" Value=".property class System.IO.Stream BaseStream { public hidebysig virtual specialname class System.IO.Stream get_BaseStream() }" />
<MemberSignature Language="C#" Value="public virtual System.IO.Stream BaseStream { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IO.Stream BaseStream" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>
<para>The <see cref="T:System.IO.Stream" /> the current <see cref="T:System.IO.StreamWriter" /> instance
is writing to.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the underlying stream that interfaces with a backing store.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Close">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Close()" />
<MemberSignature Language="C#" Value="public override void Close ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Close() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.Stream.Close" />.</para>
<para>This implementation of <see cref="M:System.IO.StreamWriter.Close" /> calls the <see cref="M:System.IO.StreamWriter.Dispose(System.Boolean)" /> method passing a true value.</para>
<para>You must call <see cref="M:System.IO.StreamWriter.Close" /> to ensure that all data is correctly written out to the underlying stream. Following a call to <see cref="M:System.IO.StreamWriter.Close" />, any operations on the <see cref="T:System.IO.StreamWriter" /> might raise exceptions. If there is insufficient space on the disk, calling <see cref="M:System.IO.StreamWriter.Close" /> will raise an exception.</para>
<para>Flushing the stream will not flush its underlying encoder unless you explicitly call <see cref="M:System.IO.StreamWriter.Flush" /> or <see cref="M:System.IO.StreamWriter.Close" />. Setting <see cref="P:System.IO.StreamWriter.AutoFlush" /> to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Closes the current StreamWriter object and the underlying stream.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="ILASM" Value=".method family hidebysig virtual void Dispose(bool disposing)" />
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.IO.StreamWriter" /> references. This method invokes the Dispose method of each referenced object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases the unmanaged resources used by the <see cref="T:System.IO.StreamWriter" /> and optionally releases the managed resources.</para>
</summary>
<param name="disposing">
<attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Encoding">
<MemberSignature Language="ILASM" Value=".property class System.Text.Encoding Encoding { public hidebysig virtual specialname class System.Text.Encoding get_Encoding() }" />
<MemberSignature Language="C#" Value="public override System.Text.Encoding Encoding { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding Encoding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>
<para>The <see cref="T:System.Text.Encoding" /> specified in
the constructor for the current instance, or <see cref="T:System.Text.UTF8Encoding" />
if an encoding was not
specified.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property is necessary for some XML scenarios where a header must be written containing the encoding used by the <see cref="T:System.IO.StreamWriter" />. This allows the XML code to consume an arbitrary <see cref="T:System.IO.StreamWriter" /> and generate the correct XML header.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:System.Text.Encoding" /> in which the output is written.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="ILASM" Value=".method family hidebysig virtual void Finalize()" />
<MemberSignature Language="C#" Value="~StreamWriter ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<block subset="none" type="note">
<para>Application code does not call this
method; it is automatically invoked by during garbage collection unless
finalization by the garbage collector has been disabled. For more information,
see <see cref="M:System.GC.SuppressFinalize(System.Object)" />, and <see cref="M:System.Object.Finalize" />.</para>
<para> This method overrides <see cref="M:System.Object.Finalize" /> . </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Frees the resources of the current <see cref="T:System.IO.StreamWriter" /> before it is reclaimed by the garbage collector.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Flush()" />
<MemberSignature Language="C#" Value="public override void Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Flush() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<exception cref="T:System.ObjectDisposedException">The current writer is closed.</exception>
<exception cref="T:System.IO.IOException"> An I/O error occurred.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.TextWriter.Flush" />.</para>
<para>Flushing the stream will not flush its underlying encoder unless you explicitly call Flush or <see cref="M:System.IO.StreamWriter.Close" />. Setting <see cref="P:System.IO.StreamWriter.AutoFlush" /> to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="FlushAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task FlushAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task FlushAsync() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous flush operation.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Null">
<MemberSignature Language="C#" Value="public static readonly System.IO.StreamWriter Null;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.IO.StreamWriter Null" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.StreamWriter</ReturnType>
</ReturnValue>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use Null to redirect output to a StreamWriter that will not consume any operating system resources.</para>
<para>When the StreamWriter.Write methods are invoked on Null, the call simply returns, and no data is actually written to any backing store.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a StreamWriter with no backing store that can be written to, but not read from.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Write(valuetype System.Char value)" />
<MemberSignature Language="C#" Value="public override void Write (char value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(char value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Char" />
</Parameters>
<Docs>
<exception cref="T:System.ObjectDisposedException">The current writer is closed.</exception>
<exception cref="T:System.NotSupportedException">
<see cref="P:System.IO.StreamWriter.AutoFlush" /> is <see langword="true" /> or the <see cref="T:System.IO.StreamWriter" /> buffer is full, and the contents of the buffer cannot be written to the underlying fixed size stream because the <see cref="T:System.IO.StreamWriter" /> is at the end the stream.</exception>
<exception cref="T:System.IO.IOException"> An I/O error occurred.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.TextWriter.Write(System.Char)" />.</para>
<para>The specified character is written to the underlying stream unless the end of the stream is reached prematurely. If <see cref="P:System.IO.StreamWriter.AutoFlush" /> is true, <see cref="M:System.IO.StreamWriter.Flush" /> is invoked automatically.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a character to the stream.</para>
</summary>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The character to write to the stream. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Write">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Write(class System.Char[] buffer)" />
<MemberSignature Language="C#" Value="public override void Write (char[] buffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(char[] buffer) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
</Parameters>
<Docs>
<exception cref="T:System.ObjectDisposedException">The current writer is closed.</exception>
<exception cref="T:System.NotSupportedException">
<see cref="P:System.IO.StreamWriter.AutoFlush" /> is <see langword="true" /> or the <see cref="T:System.IO.StreamWriter" /> buffer is full, and the contents of the buffer cannot be written to the underlying fixed size stream because the <see cref="T:System.IO.StreamWriter" /> is at the end the stream.</exception>
<exception cref="T:System.IO.IOException"> An I/O error occurred.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.TextWriter.Write(System.Char)" />.</para>
<para>The specified characters are written to the underlying stream unless the end of the stream is reached prematurely. If <see cref="P:System.IO.StreamWriter.AutoFlush" /> is true, <see cref="M:System.IO.StreamWriter.Flush" /> is invoked automatically.</para>
<para>This method might provide faster performance than Write (<paramref name="char[]," /> <paramref name="int," /> <paramref name="int" />) because it has fewer arguments to check.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a character array to the stream.</para>
</summary>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A character array containing the data to write. If <paramref name="buffer" /> is null, nothing is written. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Write">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Write(string value)" />
<MemberSignature Language="C#" Value="public override void Write (string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(string value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<exception cref="T:System.ObjectDisposedException">The current writer is closed.</exception>
<exception cref="T:System.NotSupportedException">
<see cref="P:System.IO.StreamWriter.AutoFlush" /> is <see langword="true" /> or the <see cref="T:System.IO.StreamWriter" /> buffer is full, and the contents of the buffer cannot be written to the underlying fixed size stream because the <see cref="T:System.IO.StreamWriter" /> is at the end the stream.</exception>
<exception cref="T:System.IO.IOException"> An I/O error occurred.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.TextWriter.Write(System.Char)" />.</para>
<para>The specified <see cref="T:System.String" /> is written to the underlying stream unless the end of the stream is reached prematurely.</para>
<para>
<see cref="M:System.IO.StreamWriter.Flush" /> is invoked automatically if <see cref="P:System.IO.StreamWriter.AutoFlush" /> is true. If <paramref name="value" /> is null, no entries are written.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a string to the stream.</para>
</summary>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The string to write to the stream. If <paramref name="value" /> is null, nothing is written. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Write">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Write(class System.Char[] buffer, int32 index, int32 count)" />
<MemberSignature Language="C#" Value="public override void Write (char[] buffer, int index, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(char[] buffer, int32 index, int32 count) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">buffer.Length - <paramref name="index " /> < <paramref name="count" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> or <paramref name="count" /> is negative.</exception>
<exception cref="T:System.ObjectDisposedException">The current writer is closed.</exception>
<exception cref="T:System.NotSupportedException">
<see cref="P:System.IO.StreamWriter.AutoFlush" /> is <see langword="true" /> or the <see cref="T:System.IO.StreamWriter" /> buffer is full, and the contents of the buffer cannot be written to the underlying fixed size stream because the <see cref="T:System.IO.StreamWriter" /> is at the end the stream.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides <see cref="M:System.IO.TextWriter.Write(System.Char)" />.</para>
<para>The characters are read from <paramref name="buffer" /> beginning at <paramref name="index" /> and continuing through <paramref name="index" /> + (<paramref name="count" /> - 1). All characters are written to the underlying stream unless the end of the underlying stream is reached prematurely. <see cref="M:System.IO.StreamWriter.Flush" /> is invoked automatically if <see cref="P:System.IO.StreamWriter.AutoFlush" /> is true.</para>
<para>For a list of common I/O tasks, see <format type="text/html"><a href="bf00c380-706a-4e38-b829-454a480629fc">Common I/O Tasks</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a subarray of characters to the stream.</para>
</summary>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A character array that contains the data to write. </param>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The character position in the buffer at which to start reading data. </param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of characters to write. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteAsync (char value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteAsync(char value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Char" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a character to the stream asynchronously.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The character to write to the stream.</param>
</Docs>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteAsync (string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteAsync(string value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a string to the stream asynchronously.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The string to write to the stream. If <paramref name="value" /> is null, nothing is written.</param>
</Docs>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteAsync(char[] buffer, int32 index, int32 count) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a subarray of characters to the stream asynchronously.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A character array that contains the data to write.</param>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The character position in the buffer at which to begin reading data.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of characters to write.</param>
</Docs>
</Member>
<Member MemberName="WriteLineAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteLineAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteLineAsync() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The line terminator is defined by the <see cref="P:System.IO.TextWriter.NewLine" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a line terminator asynchronously to the stream.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
</Docs>
</Member>
<Member MemberName="WriteLineAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteLineAsync (char value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteLineAsync(char value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Char" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The line terminator is defined by the <see cref="P:System.IO.TextWriter.NewLine" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a character followed by a line terminator asynchronously to the stream.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The character to write to the stream.</param>
</Docs>
</Member>
<Member MemberName="WriteLineAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteLineAsync (string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteLineAsync(string value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The line terminator is defined by the <see cref="P:System.IO.TextWriter.NewLine" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a string followed by a line terminator asynchronously to the stream.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The string to write. If the value is null, only a line terminator is written. </param>
</Docs>
</Member>
<Member MemberName="WriteLineAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task WriteLineAsync (char[] buffer, int index, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task WriteLineAsync(char[] buffer, int32 index, int32 count) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The line terminator is defined by the <see cref="P:System.IO.TextWriter.NewLine" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a subarray of characters followed by a line terminator asynchronously to the stream.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A task that represents the asynchronous write operation.</para>
</returns>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />The character array to write data from.</param>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The character position in the buffer at which to start reading data.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of characters to write.</param>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|