Export (0) Print
Expand All

StringWriter.WriteLineAsync Method (Char[], Int32, Int32)

.NET Framework 4.5

Writes a subarray of characters followed by a line terminator asynchronously to the string.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public override Task WriteLineAsync(
	char[] buffer,
	int index,
	int count
)

Parameters

buffer
Type: System.Char[]

The character array to write data from.

index
Type: System.Int32

The position in the buffer at which to start reading data.

count
Type: System.Int32

The maximum number of characters to write.

Return Value

Type: System.Threading.Tasks.Task
A task that represents the asynchronous write operation.

ExceptionCondition
ArgumentNullException

buffer is null.

ArgumentException

The index plus count is greater than the buffer length.

ArgumentOutOfRangeException

index or count is negative.

ObjectDisposedException

The string writer is disposed.

InvalidOperationException

The string writer is currently in use by a previous write operation.

The line terminator is defined by the TextWriter.NewLine property.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following example shows how to write characters by using the WriteLineAsync(Char[], Int32, Int32) method.

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));

                await writer.WriteLineAsync(charsToAdd, 0, charsToAdd.Length);

                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output: 
// 
// Characters in StringBuilder 
// and chars to add 
//

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft