ODataOutputContext.WriteErrorAsync(ODataError, Boolean) Method

Reference

Definition

Namespace:: Microsoft.OData

Assembly:: Microsoft.OData.Core.dll

Package:: Microsoft.OData.Core v7.9.0

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.

Asynchronously writes an ODataError as the message payload.

public virtual System.Threading.Tasks.Task WriteErrorAsync (Microsoft.OData.ODataError odataError, bool includeDebugInformation);

abstract member WriteErrorAsync : Microsoft.OData.ODataError * bool -> System.Threading.Tasks.Task
override this.WriteErrorAsync : Microsoft.OData.ODataError * bool -> System.Threading.Tasks.Task

Public Overridable Function WriteErrorAsync (odataError As ODataError, includeDebugInformation As Boolean) As Task

Parameters

odataError: ODataError

The error to write.

includeDebugInformation: Boolean

A flag indicating whether debug information (e.g., the inner error from the odataError) should be included in the payload. This should only be used in debug scenarios.

Returns

Task

A task representing the asynchronous operation of writing the error.

Remarks

It is the responsibility of this method to flush the output before the task finishes.

Applies to

Jaa