PipeStream.WriteAsync 方法

定義

命名空間:

System.IO.Pipes

組件:

System.IO.Pipes.dll

多載

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	以非同步的方式將一連串的位元組寫入目前的資料流，由這個資料流中目前的位置前移寫入的位元組數目，並且監視取消要求。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	以非同步方式從起始於指定位置的位元組陣列寫入所指定位元組數、依寫入的位元組數將此資料流中目前位置往前移，並監視取消要求。

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

來源:

PipeStream.Unix.cs

以非同步的方式將一連串的位元組寫入目前的資料流，由這個資料流中目前的位置前移寫入的位元組數目，並且監視取消要求。

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

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

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

參數

buffer

ReadOnlyMemory<Byte>

資料寫入來源的記憶體區域。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

ValueTask

表示非同步寫入作業的工作。

例外狀況

NotSupportedException

資料流不支援寫入。

ObjectDisposedException

無法存取關閉的管道。

IOException

管道已中斷。

InvalidOperationException

管道尚未連接。

-或-

管道處於中斷連接狀態。

-或-

尚未設定管道控制代碼。 (您的 PipeStream 實作是否呼叫 InitializeHandle(SafePipeHandle, Boolean, Boolean)？

OperationCanceledException

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

方法 WriteAsync 可讓您執行耗用大量資源的 I/O 作業，而不會封鎖主執行緒。 此效能考慮在耗時串流作業可能會封鎖 UI 執行緒，並讓應用程式顯示為無法運作的應用程式中特別重要。 非同步方法會與 Visual Basic 和 C# 中的 和 await 關鍵字搭配 async 使用。

CanWrite使用 屬性來判斷目前的實例是否支援寫入。

如果作業在完成之前取消，則傳回的工作會 Canceled 包含 屬性的值 Status 。

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

來源:

PipeStream.Unix.cs

以非同步方式從起始於指定位置的位元組陣列寫入所指定位元組數、依寫入的位元組數將此資料流中目前位置往前移，並監視取消要求。

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

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

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

Public Overrides 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

buffer.Length - offset 小於 count。

NotSupportedException

資料流不支援寫入。

ObjectDisposedException

無法存取關閉的管道。

IOException

管道已中斷。

InvalidOperationException

管道尚未連接。

-或-

管道處於中斷連接狀態。

-或-

尚未設定管道控制代碼。 (您的 PipeStream 實作是否呼叫 InitializeHandle(SafePipeHandle, Boolean, Boolean)？

OperationCanceledException

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

方法 WriteAsync 可讓您執行耗用大量資源的 I/O 作業，而不會封鎖主執行緒。 此效能考慮在耗時串流作業可能會封鎖 UI 執行緒，並讓應用程式顯示為無法運作的應用程式中特別重要。 非同步方法會與 Visual Basic 和 C# 中的 和 await 關鍵字搭配 async 使用。

CanWrite使用 屬性來判斷目前的實例是否支援寫入。

如果作業在完成之前取消，則傳回的工作會 TaskStatus.Canceled 包含 屬性的值 Status 。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 Write(Byte[], Int32, Int32) 例外狀況。