Activity.SetStatus(ActivityStatusCode, String) Method

Reference

Definition

Namespace:: System.Diagnostics

Assembly:: System.Diagnostics.DiagnosticSource.dll

Package:: System.Diagnostics.DiagnosticSource v9.0.0-preview.3.24172.9

Source:: Activity.cs

Source:: Activity.cs

Source:: Activity.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.

Sets the status code and description on the current activity object.

public System.Diagnostics.Activity SetStatus (System.Diagnostics.ActivityStatusCode code, string? description = default);

member this.SetStatus : System.Diagnostics.ActivityStatusCode * string -> System.Diagnostics.Activity

Public Function SetStatus (code As ActivityStatusCode, Optional description As String = Nothing) As Activity

Parameters

code: ActivityStatusCode

The status code

description: String

The error status description

Returns

Activity

this for convenient chaining.

Remarks

When passing code value different than ActivityStatusCode.Error, the Activity.StatusDescription will reset to null value. The description parameter will be respected only when passing ActivityStatusCode.Error value.

Applies to