اقرأ باللغة الإنجليزية تحرير

مشاركة عبر


StringReader.ReadAsync Method

Definition

Overloads

ReadAsync(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

ReadAsync(Memory<Char>, CancellationToken)

Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

ReadAsync(Char[], Int32, Int32)

Source:
StringReader.cs
Source:
StringReader.cs
Source:
StringReader.cs

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

C#
public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
C#
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

Parameters

buffer
Char[]

When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

The position in buffer at which to begin writing.

count
Int32

The maximum number of characters to read. If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

Attributes

Exceptions

buffer is null.

index or count is negative.

The sum of index and count is larger than the buffer length.

The string reader has been disposed.

The reader is currently in use by a previous read operation.

Examples

The following example shows how to read the first 23 characters of a string asynchronously.

C#
using System;
using System.IO;

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

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Remarks

The task completes after either the number of characters specified by the count parameter are read or the end of the string is reached.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Read(Char[], Int32, Int32).

Applies to

.NET 9 والإصدارات الأخرى
منتج الإصدارات
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

ReadAsync(Memory<Char>, CancellationToken)

Source:
StringReader.cs
Source:
StringReader.cs
Source:
StringReader.cs

Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

C#
public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

Parameters

buffer
Memory<Char>

When this method returns, contains the characters read from the current source.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer.

Exceptions

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 والإصدارات الأخرى
منتج الإصدارات
.NET Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1