FileStream.ReadAsync 方法

参考

定义

命名空间:: System.IO

程序集:: System.Runtime.dll

程序集:: netstandard.dll

程序集:: mscorlib.dll, System.IO.FileSystem.dll

程序集:: System.IO.FileSystem.dll

程序集:: mscorlib.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

ReadAsync(Memory<Byte>, CancellationToken)	从当前文件流异步读取字节的序列，将其写入某内存区域，按读取的字节数向前移动文件流中的位置，并监视取消请求。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	从当前文件流异步读取字节的序列，将其写入从指定偏移量开始的字节数组，按读取的字节数向前移动文件流中的位置，并监视取消请求。

ReadAsync(Memory<Byte>, CancellationToken)

Source:: FileStream.cs

Source:: FileStream.cs

Source:: FileStream.cs

从当前文件流异步读取字节的序列，将其写入某内存区域，按读取的字节数向前移动文件流中的位置，并监视取消请求。

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

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

参数

buffer: Memory<Byte>

要写入数据的缓冲区。

cancellationToken: CancellationToken

要监视取消请求的标记。默认值为 None。

ValueTask<Int32>

一个表示异步读取操作并将读取的总字节数包装到缓冲区中的任务。如果当前可用字节数少于所请求的字节数，则该结果值可小于所请求的字节数；如果已到达流结尾时，则为 0（零）。

例外

OperationCanceledException

取消令牌已取消。此异常存储在返回的任务中。

示例

以下示例演示如何以异步方式从文件中读取数据。

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

注解

使用 ReadAsync 方法可以执行资源密集型文件操作，而不会阻止main线程。在 Windows 8.x 应用商店应用或桌面应用中一个耗时的流操作可能阻塞 UI 线程并让应用看起来好像不工作时，这种性能的考虑就显得尤为重要了。异步方法与 async Visual Basic 和 C# 中的和 await 关键字结合使用。

CanRead使用属性确定当前实例是否支持读取。

如果在操作完成之前取消了操作，则返回的任务将包含 TaskStatus.Canceled 属性的值 Status 。如果释放了文件的句柄，则返回的任务 ObjectDisposedException 在属性中包含 Task.Exception 异常。

适用于

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Source:: FileStream.cs

Source:: FileStream.cs

Source:: FileStream.cs

从当前文件流异步读取字节的序列，将其写入从指定偏移量开始的字节数组，按读取的字节数向前移动文件流中的位置，并监视取消请求。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

参数

buffer: Byte[]

要写入数据的缓冲区。

offset: Int32

buffer 中的字节偏移量，从该偏移量开始写入从流中读取的数据。

count: Int32

最多读取的字节数。

cancellationToken: CancellationToken

要监视取消请求的标记。

Task<Int32>

属性: ComVisibleAttribute

例外

ArgumentNullException

buffer 为 null。

ArgumentOutOfRangeException

offset 或 count 为负数。

ArgumentException

offset 和 count 的总和大于缓冲区长度。

NotSupportedException

流不支持读取。

ObjectDisposedException

已释放流。

InvalidOperationException

之前的读取操作当前正在使用流。

OperationCanceledException

取消令牌已取消。此异常存储在返回的任务中。

示例

以下示例演示如何以异步方式从文件中读取数据。

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

注解

CanRead使用属性确定当前实例是否支持读取。

如果在操作完成之前取消了操作，则返回的任务将包含 TaskStatus.Canceled 属性的值 Task.Status 。如果释放了文件的句柄，则返回的任务 ObjectDisposedException 在属性中包含 Task.Exception 异常。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。如果异常存储在返回的任务中，则在等待任务时将引发该异常。使用异常（如 ArgumentException）仍会同步引发。有关存储的异常，请参阅引发的 Read(Byte[], Int32, Int32)异常。

另请参阅

取消

适用于

通过

FileStream.ReadAsync 方法

定义

重载

ReadAsync(Memory<Byte>, CancellationToken)

参数

返回

例外

示例

注解

适用于

ReadAsync(Byte[], Int32, Int32, CancellationToken)

参数

返回

例外

示例

注解

另请参阅

适用于

其他资源