IActorStateManager.TryRemoveStateAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.ServiceFabric.Actors.Runtime

Assembly:: Microsoft.ServiceFabric.Actors.dll

Package:: Microsoft.ServiceFabric.Actors v6.1.1583

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 remove an actor state with specified state name.

public System.Threading.Tasks.Task<bool> TryRemoveStateAsync (string stateName, System.Threading.CancellationToken cancellationToken = default);

abstract member TryRemoveStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Function TryRemoveStateAsync (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

stateName: String

Name of the actor state to remove.

cancellationToken: CancellationToken

The token to monitor for cancellation requests.

Returns

Task<Boolean>

A task that represents the asynchronous remove operation. The value of TResult parameter indicates if the state was successfully removed.

Exceptions

ArgumentNullException

The specified state name is null.

OperationCanceledException

The operation was canceled.

Applies to