MemoryDistributedCache.SetAsync Method

Definition

Namespace:

Microsoft.Extensions.Caching.Distributed

Assembly:

Microsoft.Extensions.Caching.Memory.dll

Package:

Microsoft.Extensions.Caching.Memory v9.0.0

Source:

MemoryDistributedCache.cs

Asynchronously sets the specified item associated with a key in the IMemoryCache as a byte array.

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

The key of the item to set.

value

Byte[]

The byte array value of the item to set.

options

DistributedCacheEntryOptions

The cache options for the item to set.

token

CancellationToken

The CancellationToken to use to cancel operation.

Returns

Task

The task for setting the byte array value associated with the specified key in the cache.

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).