Stream.WriteAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

将字节序列异步写入当前流，并将流的当前位置提升写入的字节数。

重载

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	将字节的序列异步写入当前流，将该流中的当前位置向前移动写入的字节数，并监视取消请求。
WriteAsync(Byte[], Int32, Int32)	将字节序列异步写入当前流，并将流的当前位置提升写入的字节数。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	将字节的序列异步写入当前流，将该流中的当前位置向前移动写入的字节数，并监视取消请求。

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Source:

Stream.cs

将字节的序列异步写入当前流，将该流中的当前位置向前移动写入的字节数，并监视取消请求。

public virtual System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

abstract member WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Overridable Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

参数

buffer

ReadOnlyMemory<Byte>

从中写入数据的内存区域。

cancellationToken

CancellationToken

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

返回

ValueTask

表示异步写入操作的任务。

例外

OperationCanceledException

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

注解

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

CanWrite使用 属性确定当前实例是否支持写入。

如果在操作完成之前取消了操作，则返回的任务将包含 Canceled 属性的值 Status 。

有关示例，请参阅 WriteAsync(Byte[], Int32, Int32) 重载。

WriteAsync(Byte[], Int32, Int32)

Source:

Stream.cs

将字节序列异步写入当前流，并将流的当前位置提升写入的字节数。

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

public System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count);

member this.WriteAsync : byte[] * int * int -> System.Threading.Tasks.Task

Public Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer) As Task

参数

buffer

Byte[]

从中写入数据的缓冲区。

offset

Int32

buffer 中的从零开始的字节偏移量，从此处开始将字节复制到该流。

count

Int32

最多写入的字节数。

返回

Task

表示异步写入操作的任务。

例外

ArgumentNullException

buffer 为 null。

ArgumentOutOfRangeException

offset 或 count 为负数。

ArgumentException

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

NotSupportedException

流不支持写入。

ObjectDisposedException

已释放流。

InvalidOperationException

流正在由前一次写操作使用。

示例

以下示例演示如何以异步方式写入文件。 该示例使用 FileStream 派生自 类的 Stream 类。

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)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

注解

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

CanWrite使用 属性确定当前实例是否支持写入。

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

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

Source:

Stream.cs

将字节的序列异步写入当前流，将该流中的当前位置向前移动写入的字节数，并监视取消请求。

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

public virtual System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

abstract member WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

参数

buffer

Byte[]

从中写入数据的缓冲区。

offset

Int32

buffer 中的从零开始的字节偏移量，从此处开始将字节复制到该流。

count

Int32

最多写入的字节数。

cancellationToken

CancellationToken

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

返回

Task

表示异步写入操作的任务。

例外

ArgumentNullException

buffer 为 null。

ArgumentOutOfRangeException

offset 或 count 为负数。

ArgumentException

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

NotSupportedException

流不支持写入。

ObjectDisposedException

已释放流。

InvalidOperationException

流正在由前一次写操作使用。

OperationCanceledException

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

注解

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

CanWrite使用 属性确定当前实例是否支持写入。

如果在操作完成之前取消了操作，则返回的任务将包含 Canceled 属性的值 Status 。

有关示例，请参阅 WriteAsync(Byte[], Int32, Int32) 重载。

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

另请参阅

• 取消