ODataMessageWriter.WriteErrorAsync Method

Asynchronously writes an ODataError as the message payload.

Namespace:  Microsoft.Data.OData
Assembly:  Microsoft.Data.OData (in Microsoft.Data.OData.dll)

Syntax

'Declaration
Public Function WriteErrorAsync ( _
    error As ODataError, _
    includeDebugInformation As Boolean _
) As Task
'Usage
Dim instance As ODataMessageWriter 
Dim error As ODataError 
Dim includeDebugInformation As Boolean 
Dim returnValue As Task 

returnValue = instance.WriteErrorAsync(error, _
    includeDebugInformation)

public Task WriteErrorAsync(
    ODataError error,
    bool includeDebugInformation
)

public:
Task^ WriteErrorAsync(
    ODataError^ error, 
    bool includeDebugInformation
)

member WriteErrorAsync : 
        error:ODataError * 
        includeDebugInformation:bool -> Task

public function WriteErrorAsync(
    error : ODataError, 
    includeDebugInformation : boolean
) : Task

Parameters

• error
  Type: Microsoft.Data.OData.ODataError
  The error to write.

• includeDebugInformation
  Type: System.Boolean
  A flag indicating whether debug information (for example, the inner error from the error) should be included in the payload. This should only be used in debug scenarios.

Return Value

Type: System.Threading.Tasks.Task
A task representing the asynchronous operation of writing the error.

See Also

Reference

ODataMessageWriter Class

Microsoft.Data.OData Namespace