Edit

ChannelWriter<T>.TryComplete(Exception) Method

  • Reference

Definition

Namespace:
System.Threading.Channels
Assembly:
System.Threading.Channels.dll
Package:
System.Threading.Channels v8.0.0
Package:
System.Threading.Channels v9.0.0-preview.3.24172.9
Source:
ChannelWriter.cs
Source:
ChannelWriter.cs
Source:
ChannelWriter.cs

Attempts to mark the channel as being completed, meaning no more data will be written to it.

public virtual bool TryComplete (Exception error = default);
public virtual bool TryComplete (Exception? error = default);
abstract member TryComplete : Exception -> bool
override this.TryComplete : Exception -> bool
Public Overridable Function TryComplete (Optional error As Exception = Nothing) As Boolean

Parameters

error
Exception

An Exception indicating the failure causing no more data to be written, or null for success.

Returns

Boolean

true if this operation successfully completes the channel; otherwise, false if the channel could not be marked for completion, for example due to having already been marked as such, or due to not supporting completion. .

Applies to