RedisCache.SetAsync Method

Reference

Definition

Namespace:: Microsoft.Extensions.Caching.StackExchangeRedis

Assembly:: Microsoft.Extensions.Caching.StackExchangeRedis.dll

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 value with the given key.

public System.Threading.Tasks.Task SetAsync (string key, byte[] value, Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions options, System.Threading.CancellationToken token = default);

abstract member SetAsync : string * byte[] * Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SetAsync : string * byte[] * Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SetAsync (key As String, value As Byte(), options As DistributedCacheEntryOptions, Optional token As CancellationToken = Nothing) As Task

Parameters

key: String

A string identifying the requested value.

value: Byte[]

The value to set in the cache.

options: DistributedCacheEntryOptions

The cache options for the value.

token: CancellationToken

Optional. The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

Task

The Task that represents the asynchronous operation.

Implements

SetAsync(String, Byte[], DistributedCacheEntryOptions, CancellationToken)

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Set(String, Byte[], DistributedCacheEntryOptions).

Applies to