Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ChannelWriter<T>.TryComplete(Exception) Method
Definition
- Namespace:
- System.Threading.Channels
- Assembly:
- System.Threading.Channels.dll
- Package:
- System.Threading.Channels v11.0.0-preview.5.26302.115
- Source:
- ChannelWriter.cs
- Source:
- ChannelWriter.cs
- Source:
- ChannelWriter.cs
- Source:
- ChannelWriter.cs
- Source:
- ChannelWriter.cs
- Source:
- ChannelWriter.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 -> boolPublic Overridable Function TryComplete (Optional error As Exception = Nothing) As BooleanParameters
- error
- Exception
An Exception indicating the failure causing no more data to be written, or null for success.
Returns
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
Feedback
Was this page helpful?